IPDaemon Class

Properties   Methods   Events   Configuration Settings   Errors  

The IPDaemon Class is a generic TCP server class based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Class Name

IPWorks_IPDaemon

Procedural Interface

 ipworks_ipdaemon_open();
 ipworks_ipdaemon_close($res);
 ipworks_ipdaemon_register_callback($res, $id, $function);
 ipworks_ipdaemon_get_last_error($res);
 ipworks_ipdaemon_get_last_error_code($res);
 ipworks_ipdaemon_set($res, $id, $index, $value);
 ipworks_ipdaemon_get($res, $id, $index);
 ipworks_ipdaemon_do_config($res, $configurationstring);
 ipworks_ipdaemon_do_disconnect($res, $connectionid);
 ipworks_ipdaemon_do_doevents($res);
 ipworks_ipdaemon_do_interrupt($res, $connectionid);
 ipworks_ipdaemon_do_reset($res);
 ipworks_ipdaemon_do_send($res, $connectionid, $text);
 ipworks_ipdaemon_do_sendfile($res, $connectionid, $filename);
 ipworks_ipdaemon_do_sendline($res, $connectionid, $text);
 ipworks_ipdaemon_do_shutdown($res);
 ipworks_ipdaemon_do_startssl($res, $connectionid);

Remarks

The IPDaemon Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method. The SSLCert properties are used to select a certificate for the server (please note that a valid certificate MUST be selected before the server can function).

IPDaemon is the server complement of IPPort (which is used to create client applications). They share a common design philosophy and interface. We expect you will find IPDaemon as easy to use as IPPort.

By default, each instance of IPDaemon can handle up to 1,000 simultaneous incoming connections (this number may be increased up to 100,000 or decreased to a lower value by using the MaxConnections configuration setting).

The connections are identified by a ConnectionId, an id generated by the component to identify each connection. This id is unique to each connection. IPDaemon's events also have ConnectionId as a parameter to identify the connection they relate to.

Our main goal in designing IPDaemon was to make it easy to use without sacrificing performance. The class has a minimum of properties, and six events: ConnectionRequest, Connected, DataIn, Disconnected, ReadyToSend, and Error.

IPDaemon can start to listen on a port by setting the Listening property to True. When a remote host asks for a connection, the ConnectionRequest event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to IPPort. Data is sent by assigning the data string to the DataToSend property. The address and port of the incoming connection can be found by querying the RemoteHost and RemotePort properties.

Note: Server components are designed to process events as they occur. To ensure events are processed in a timely manner DoEvents should be called in a loop after the server is started.