Difference between revisions of "ApCoCoA-1:BBF.SwitchPort"
(Types section update.) |
(Types section update.) |
||
| Line 1: | Line 1: | ||
<command> | <command> | ||
| − | + | <title>BBF.SwitchPort</title> | |
| − | + | <short_description>Change ApCoCoABBFServer communication port.</short_description> | |
| − | <syntax> | + | <syntax>BBF.SwitchPort(NewPort:INT):INT</syntax> |
| − | BBF.SwitchPort(NewPort:INT):INT | + | <description> |
| − | </syntax> | ||
| − | |||
Use <tt>NewPort</tt> (>= 48112) as new port number for communication with ApCoCoABBFServer. This is useful if you want to run more than one instance of the ApCoCoABBFServer at the same time. You can associate a port number to the ApCoCoABBFServer on startup via the <tt>--port</tt> flag. | Use <tt>NewPort</tt> (>= 48112) as new port number for communication with ApCoCoABBFServer. This is useful if you want to run more than one instance of the ApCoCoABBFServer at the same time. You can associate a port number to the ApCoCoABBFServer on startup via the <tt>--port</tt> flag. | ||
| − | |||
<itemize> | <itemize> | ||
<item>@param <em>NewPort</em> New port number for communication with ApCoCoABBFServer.</item> | <item>@param <em>NewPort</em> New port number for communication with ApCoCoABBFServer.</item> | ||
<item>@return The previously used port number.</item> | <item>@return The previously used port number.</item> | ||
</itemize> | </itemize> | ||
| − | |||
<em>Beta Warning:</em> This method, package or class is a beta version. It may not work as intended or its interface may change in the next version! So please be careful when you're intending to use it. | <em>Beta Warning:</em> This method, package or class is a beta version. It may not work as intended or its interface may change in the next version! So please be careful when you're intending to use it. | ||
<par/> | <par/> | ||
| Line 21: | Line 17: | ||
------------------------------- | ------------------------------- | ||
</example> | </example> | ||
| − | + | </description> | |
| − | <types> | + | <types> |
| − | <type>int</type> | + | <type>int</type> |
| − | <type>integer</type> | + | <type>integer</type> |
| − | </types> | + | <type>borderbasis</type> |
| − | + | </types> | |
| − | + | <see>BB.BBasis</see> | |
| − | + | <key>SwitchPort</key> | |
| − | + | <key>BBF.SwitchPort</key> | |
| + | <wiki-category>Package_bbf</wiki-category> | ||
</command> | </command> | ||
Revision as of 12:14, 24 April 2009
BBF.SwitchPort
Change ApCoCoABBFServer communication port.
Syntax
BBF.SwitchPort(NewPort:INT):INT
Description
Use NewPort (>= 48112) as new port number for communication with ApCoCoABBFServer. This is useful if you want to run more than one instance of the ApCoCoABBFServer at the same time. You can associate a port number to the ApCoCoABBFServer on startup via the --port flag.
@param NewPort New port number for communication with ApCoCoABBFServer.
@return The previously used port number.
Beta Warning: This method, package or class is a beta version. It may not work as intended or its interface may change in the next version! So please be careful when you're intending to use it.
It is very likely to happen that the port switching functionality will be changed in future releases as soon as a more sophisticated multiple computation handling has been implemented.
Example
BBF.SwitchPort(48113); 48112 -------------------------------
