newspeoplefor developersdocumentationdownloads

nNetServer Script Interface

nnetserver:

Super Class:

C++ Class:

Info

The network server object.

Commands:


setportname

Command Input:
s(PortName)
Command Output:
v
Command Description:
Set the communication port name name.

getportname

Command Input:
v
Command Output:
s(PortName)
Command Description:
Get the communication port name.

beginclients

Command Input:
i(NumClients)
Command Output:
v
Command Description:
Begin configuration clients which are allowed to connect. Only clients added between beginclients and endclients will be allowed to join the session.

setclientguid

Command Input:
i(ClientIndex), s(ClientGuid)
Command Output:
v
Command Description:
Set the guid for a client. The guid is used to authenticate a client which wants to connect to the session.

endclients

Command Input:
v
Command Output:
v
Command Description:
Finish configuring clients.

getnumclients

Command Input:
v
Command Output:
i(NumClients)
Command Description:
Return number of configured (NOT JOINED!) clients.

getclientguidat

Command Input:
i(ClientIndex)
Command Output:
s(ClientGuid)
Command Description:
Get the client guid at index.

getclientstatusat

Command Input:
i(ClientIndex)
Command Output:
s(ClientStatus)
Command Description:
Returns the current client status.

open

Command Input:
v
Command Output:
b(Success)
Command Description:
Open the server. The server expects the configured clients to connect, once all configured clients have connected, the isstarted command will return true.

close

Command Input:
v
Command Output:
v
Command Description:
Close the server. The running session will be closed.

isopen

Command Input:
v
Command Output:
b(OpenFlag)
Command Description:
Return true if the server is open. This is the case between the open and close command.

isstarted

Command Input:
v
Command Output:
b(StartedFlag)
Command Description:
Return true if the server is in the started state. This is the case when all configured clients have connected.

Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.