IP*Works! V9

ipworks
Class Ipdaemon

java.lang.Object
  extended by ipworks.Ipdaemon

public class Ipdaemon
extends java.lang.Object

The IPDaemon Bean is used to create TCP/IP servers. The bean handles multiple simultaneous connections on the same TCP/IP port (service port). It is designed to balance the load between connections for a fast, powerful server.

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 bean 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.


Constructor Summary
Ipdaemon()
          Creates an instance of Ipdaemon Bean.
Ipdaemon(java.lang.String runtimeLicense)
          Creates an instance of Ipdaemon Bean with specified run-time license.
 
Method Summary
 void addIpdaemonEventListener(IpdaemonEventListener l)
           
 java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a configuration setting.
 void disconnect(java.lang.String connectionId)
          Disconnect the specified client.
 void doEvents()
          Processes events from the internal message queue.
 int getConnectionBacklog()
          The maximum number of pending connections maintained by the TCP/IP subsystem.
 ConnectionMap getConnections()
          A collection of currently connected clients.
 byte[] getDefaultEOL()
          A default EOL value to be used by incoming connections.
 int getDefaultMaxLineLength()
          The default maximum line length value for inbound connections.
 int getDefaultTimeout()
          An initial timeout value to be used by incoming connections.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 int getLocalPort()
          The TCP port in the local host where the bean listens.
 void interrupt(java.lang.String connectionId)
          Interrupts a synchronous send to the remote host.
 boolean isDefaultSingleLineMode()
          Tells the bean whether or not to treat new connections as line-oriented.
 boolean isKeepAlive()
          When True, KEEPALIVE packets are enabled (for long connections).
 boolean isLinger()
          When set to True, connections are terminated gracefully.
 boolean isListening()
          If True, the bean accepts incoming connections on LocalPort.
 void removeIpdaemonEventListener(IpdaemonEventListener l)
           
 void send(java.lang.String connectionId, byte[] text)
          Sends data to the remote host.
 void sendFile(java.lang.String connectionId, java.lang.String fileName)
          Send file to the remote host.
 void sendLine(java.lang.String connectionId, java.lang.String text)
          Sends a string followed by a newline.
 void setConnectionBacklog(int connectionBacklog)
          The maximum number of pending connections maintained by the TCP/IP subsystem.
 void setDefaultEOL(byte[] defaultEOL)
          A default EOL value to be used by incoming connections.
 void setDefaultMaxLineLength(int defaultMaxLineLength)
          The default maximum line length value for inbound connections.
 void setDefaultSingleLineMode(boolean defaultSingleLineMode)
          Tells the bean whether or not to treat new connections as line-oriented.
 void setDefaultTimeout(int defaultTimeout)
          An initial timeout value to be used by incoming connections.
 void setKeepAlive(boolean keepAlive)
          When True, KEEPALIVE packets are enabled (for long connections).
 void setLinger(boolean linger)
          When set to True, connections are terminated gracefully.
 void setListening(boolean listening)
          If True, the bean accepts incoming connections on LocalPort.
 void setLocalHost(java.lang.String localHost)
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 void setLocalPort(int localPort)
          The TCP port in the local host where the bean listens.
 void shutdown()
          Shuts down the server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Ipdaemon

public Ipdaemon()
Creates an instance of Ipdaemon Bean.


Ipdaemon

public Ipdaemon(java.lang.String runtimeLicense)
Creates an instance of Ipdaemon Bean with specified run-time license.

Method Detail

getConnectionBacklog

public int getConnectionBacklog()
The maximum number of pending connections maintained by the TCP/IP subsystem.

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCON option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.


setConnectionBacklog

public void setConnectionBacklog(int connectionBacklog)
                          throws IPWorksException
The maximum number of pending connections maintained by the TCP/IP subsystem.

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCON option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Throws:
IPWorksException

getConnections

public ConnectionMap getConnections()
A collection of currently connected clients.

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the connection type.

This collection is a hashtable type of collection, in which the Connection ID string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected event.

Example (Broadcasting Data)

 Iterator keys = ipdaemon1.getConnections().keySet().iterator();
 while (keys.hasNext()) {
   Connection c = (Connection) ipdaemon1.getConnections().get(keys.next());
   c.setDataToSend("Broadcast Data");
 } 


getDefaultEOL

public byte[] getDefaultEOL()
A default EOL value to be used by incoming connections.

This property contains a default End Of Line (EOL) value to be used by incoming connections. Once the bean accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.


setDefaultEOL

public void setDefaultEOL(byte[] defaultEOL)
                   throws IPWorksException
A default EOL value to be used by incoming connections.

This property contains a default End Of Line (EOL) value to be used by incoming connections. Once the bean accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

Throws:
IPWorksException

getDefaultMaxLineLength

public int getDefaultMaxLineLength()
The default maximum line length value for inbound connections.

This property controls the default size of an internal buffer which holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.


setDefaultMaxLineLength

public void setDefaultMaxLineLength(int defaultMaxLineLength)
                             throws IPWorksException
The default maximum line length value for inbound connections.

This property controls the default size of an internal buffer which holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

Throws:
IPWorksException

isDefaultSingleLineMode

public boolean isDefaultSingleLineMode()
Tells the bean whether or not to treat new connections as line-oriented.

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by CRLF, CR, or LF, and will ignore the end of lines (EOLs).


setDefaultSingleLineMode

public void setDefaultSingleLineMode(boolean defaultSingleLineMode)
                              throws IPWorksException
Tells the bean whether or not to treat new connections as line-oriented.

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by CRLF, CR, or LF, and will ignore the end of lines (EOLs).

Throws:
IPWorksException

getDefaultTimeout

public int getDefaultTimeout()
An initial timeout value to be used by incoming connections.

This property is used by the bean to set the operational timeout value of all inbound connections once they are established. By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.


setDefaultTimeout

public void setDefaultTimeout(int defaultTimeout)
                       throws IPWorksException
An initial timeout value to be used by incoming connections.

This property is used by the bean to set the operational timeout value of all inbound connections once they are established. By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Throws:
IPWorksException

isKeepAlive

public boolean isKeepAlive()
When True, KEEPALIVE packets are enabled (for long connections).

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Please note that system TCP/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.


setKeepAlive

public void setKeepAlive(boolean keepAlive)
                  throws IPWorksException
When True, KEEPALIVE packets are enabled (for long connections).

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Please note that system TCP/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Throws:
IPWorksException

isLinger

public boolean isLinger()
When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True. In this case the connection is closed only after all the data is sent. Setting it to False forces an abrupt (hard) disconnection. Any data that was in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the bean returns control immediately, the system might indefinitely hold system resources until all pending data is sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.


setLinger

public void setLinger(boolean linger)
               throws IPWorksException
When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True. In this case the connection is closed only after all the data is sent. Setting it to False forces an abrupt (hard) disconnection. Any data that was in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the bean returns control immediately, the system might indefinitely hold system resources until all pending data is sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Throws:
IPWorksException

isListening

public boolean isListening()
If True, the bean accepts incoming connections on LocalPort.

Use this property to make the bean 'listen' (accept connections) on the port specified by the LocalPort property. Setting this property to False will make the bean stop listening. (Please note that this does not close any existing connections).


setListening

public void setListening(boolean listening)
                  throws IPWorksException
If True, the bean accepts incoming connections on LocalPort.

Use this property to make the bean 'listen' (accept connections) on the port specified by the LocalPort property. Setting this property to False will make the bean stop listening. (Please note that this does not close any existing connections).

Throws:
IPWorksException

getLocalHost

public java.lang.String getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.


setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksException
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Throws:
IPWorksException

getLocalPort

public int getLocalPort()
The TCP port in the local host where the bean listens.

This property must be set before the bean can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the bean is listening (ie. after successfully assigning True to the Listening property).

The service port is not shared among servers so two beans cannot be listening on the same port at the same time.


setLocalPort

public void setLocalPort(int localPort)
                  throws IPWorksException
The TCP port in the local host where the bean listens.

This property must be set before the bean can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the bean is listening (ie. after successfully assigning True to the Listening property).

The service port is not shared among servers so two beans cannot be listening on the same port at the same time.

Throws:
IPWorksException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException
Sets or retrieves a configuration setting.

Config is a generic method available in every bean. It is used to set and retrieve configuration settings for the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

The bean accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

IPDaemon Configuration Settings

BindExclusively
Whether or not the component considers a local port reserved for exclusive use
If this is true (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance and attempts to do so will result in failure.
InBufferSize
The size in bytes of the incoming queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

InBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

MaxConnections
The maximum number of connections available
The maximum number of connections available. This property must be set before Listening is set to True, and once set, it can no longer be changed for the current instance of the bean. The maximum value for this setting is 100,000 connections.
OutBufferSize
The size in bytes of the outgoing queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

TcpNoDelay
Whether or not to delay when sending packets
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

CloseStreamAfterTransfer
If true, the component will close the upload or download stream after the transfer
This entry is for bean and all the components that descend from it.This property is true by default. Therefore, by default, all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, you must set this config to false.

Base Configuration Settings

GUIAvailable
Tells the bean whether or not a message loop is available for processing events
In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

Throws:
IPWorksException

disconnect

public void disconnect(java.lang.String connectionId)
                throws IPWorksException
Disconnect the specified client.

Calling this method will disconnect the client specified by the ConnectionId parameter.

Throws:
IPWorksException

doEvents

public void doEvents()
              throws IPWorksException
Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Throws:
IPWorksException

interrupt

public void interrupt(java.lang.String connectionId)
               throws IPWorksException
Interrupts a synchronous send to the remote host.

This property is called using the Connection ID if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the bean. If you use SendFile to upload a file, the bean will run synchronously on that Connection ID until it is completed.

Throws:
IPWorksException

send

public void send(java.lang.String connectionId,
                 byte[] text)
          throws IPWorksException
Sends data to the remote host.

This method sends data to the remote host. Calling this method is equivalent to setting the DataToSend property to Text .

Throws:
IPWorksException

sendFile

public void sendFile(java.lang.String connectionId,
                     java.lang.String fileName)
              throws IPWorksException
Send file to the remote host.

This method sends the file to the client specified by the ConnectionId .

Throws:
IPWorksException

sendLine

public void sendLine(java.lang.String connectionId,
                     java.lang.String text)
              throws IPWorksException
Sends a string followed by a newline.

This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\\r\\n") .

Please refer to the GetLine method and SingleLineMode property for more information.

Throws:
IPWorksException

shutdown

public void shutdown()
              throws IPWorksException
Shuts down the server.

This method shuts down the server. Calling this method is equivalent to setting Listening to False, and then breaking every client connection by calling Disconnect .

Throws:
IPWorksException

addIpdaemonEventListener

public void addIpdaemonEventListener(IpdaemonEventListener l)
                              throws java.util.TooManyListenersException
Throws:
java.util.TooManyListenersException

removeIpdaemonEventListener

public void removeIpdaemonEventListener(IpdaemonEventListener l)

IP*Works! V9

Copyright (c) 2013 /n software inc. - All rights reserved.