ipworks
Class Connection

java.lang.Object
  |
  +--ipworks.Connection

public class Connection

extends java.lang.Object

A timeout for the bean.

If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data can't be sent or received immediately.

If Timeout is set to a positive value, the bean will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behaviour of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 0 (asynchronous operation).

UploadStream: Setting this field uploads the data in the specified stream to the current connection.

See Also:

Atom, Atom.Connection

Method Summary

boolean	getAcceptData()
int	getBytesSent()
boolean	getConnected()
java.lang.String	getConnectionId()
byte[]	getEOL()
java.lang.String	getLocalAddress()
int	getMaxLineLength()
java.lang.String	getRemoteHost()
int	getRemotePort()
boolean	getSingleLineMode()
int	getTimeout()
void	setAcceptData(boolean value)
void	setConnected(boolean value)
void	setDataToSend(byte[] value)
void	setEOL(byte[] value)
void	setMaxLineLength(int value)
void	setSingleLineMode(boolean value)
void	setTimeout(int value)
void	setUploadStream(java.io.InputStream value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAcceptData

public boolean getAcceptData()

setAcceptData

public void setAcceptData(boolean value)

getBytesSent

public int getBytesSent()

getConnected

public boolean getConnected()

setConnected

public void setConnected(boolean value)

getConnectionId

public java.lang.String getConnectionId()

setDataToSend

public void setDataToSend(byte[] value)

getEOL

public byte[] getEOL()

setEOL

public void setEOL(byte[] value)

getLocalAddress

public java.lang.String getLocalAddress()

getMaxLineLength

public int getMaxLineLength()

setMaxLineLength

public void setMaxLineLength(int value)

getRemoteHost

public java.lang.String getRemoteHost()

getRemotePort

public int getRemotePort()

getSingleLineMode

public boolean getSingleLineMode()

setSingleLineMode

public void setSingleLineMode(boolean value)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int value)

setUploadStream

public void setUploadStream(java.io.InputStream value)