TCP

Description

TCP client/server communication functions. There are functions to run and manage local TCP servers and also for remote TCP client connections.

Categories

Name	Description
`Advanced`	Advanced TCP client/server communication functions that allow direct access to the underlying Java infrastructure.

Functions

Name	Signature and Synopsis
`connectToRemoteServer`	`void connectToRemoteServer(String sessionNickName, String host, int port)` Connects to a remote TCP server running on the given host name and port. This remote session will be registered under the nick name provided.
`createLocalServer`	`void createLocalServer(String serverNickName, String host, int port)` Starts a local TCP server using the host name and port provided. The server will be registered under the given nick name.
`disconnectFromRemoteServer`	`void disconnectFromRemoteServer(String sessionNickName)` Disconnects the remote session that was created previously using connectToRemoteServer(sessionNickName, host, port).
`disconnectLocalSession`	`void disconnectLocalSession(String sessionNickName)` Disconnects the session that was connected to the local server.
`endRead`	`void endRead(String sessionNickName)` Stops reading and signals the end of this read session.
`endWrite`	`void endWrite(String sessionNickName)` Flushes the writes and signals the end of this write session.
`readIntoPayload`	`Event readIntoPayload(String sessionNickName, int maxNumBytesToRead, String uriOfResponseEvent)` Attempts to read the maximum number of bytes specified into the payload of a new event whose URI is provided.
`readIntoPayloadFully`	`Event readIntoPayloadFully(String sessionNickName, String uriOfResponseEvent)` Attempts to read all the bytes from the stream into the payload of a new event whose URI is provided. If the stream is not going to fit into memory or is going to be very large, avoid using this method.
`registerSessionListener`	`void registerSessionListener(String serverNickName, String uriOfRuleFunction)` This must be performed before calling startLocalServer(serverNickName).
`startLocalServer`	`void startLocalServer(String serverNickName)` Starts the local server that was registered previously using createLocalServer(serverNickName, host, port).
`stopLocalServer`	`void stopLocalServer(String serverNickName)` Stops the local server that was registered under the given nick name.
`write`	`void write(String sessionNickName, Event eventWithPayload)` Writes the payload of the event provided to the TCP session. '$1$10' at the end of the payload string can be written to mark the EOF (Useful for Flash).