Difference between revisions of "ApCoCoA-1:BBF.SwitchPort"

From ApCoCoAWiki
(Updated alias usage)
m (insert version info)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{Version|1}}
 
<command>
 
<command>
    <title>BBF.SwitchPort</title>
+
  <title>BBF.SwitchPort</title>
    <short_description>change port for communication with ApCoCoABBFServer</short_description>
+
  <short_description>Changes the ApCoCoABBFServer communication port.</short_description>
 +
 
 
<syntax>
 
<syntax>
 
BBF.SwitchPort(NewPort:INT):INT
 
BBF.SwitchPort(NewPort:INT):INT
 
</syntax>
 
</syntax>
    <description>
+
  <description>
 
Use <tt>NewPort</tt> (&gt;= 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> (&gt;= 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>
The output of this function is the previously used port number for communication with the ApCoCoABBFServer.
+
  <item>@param <em>NewPort</em> New port number for communication with ApCoCoABBFServer.</item>
 
+
  <item>@return The previously used port number.</item>
{{Beta}}
+
</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.
 +
<par/>
 
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.
 
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>
 
<example>
Line 17: Line 21:
 
-------------------------------
 
-------------------------------
 
</example>
 
</example>
    </description>
+
  </description>
     <see>Border Basis Framework overview</see>
+
  <types>
    <see>BBasis</see>
+
     <type>borderbasis</type>
    <key>kaspar</key>
+
  </types>
    <key>bbf.switchport</key>
+
  <see>ApCoCoA-1:BB.BBasis|BB.BBasis</see>
    <wiki-category>Package_BBF</wiki-category>
+
  <key>SwitchPort</key>
 +
  <key>BBF.SwitchPort</key>
 +
  <wiki-category>ApCoCoA-1:Package_bbf</wiki-category>
 
</command>
 
</command>

Latest revision as of 09:49, 7 October 2020

This article is about a function from ApCoCoA-1.

BBF.SwitchPort

Changes the 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
-------------------------------

BB.BBasis