DNA_Connection

dna

1998 12-06

CLASS

DNA_Connection - C++ network peer connection

SYNOPSIS

DNA_Connection implements the behavior of a connection between two points in the network for reading and writing messages. Each operation has the concept of sources and destinations. The actual implementation of reading and writing is performed by an associated implementation object.

MEMBER FUNCTIONS

virtual GPL_Boolean IsConnected(void) const

TRUE

virtual DNA_ConnectionImp *GetConnectionImp(void) const
Return the implementation.

virtual GPL_Boolean Accept(DNA_Connection & c)
Accept, from another peer which has called Connect() , an entirely new connection, c. The connection must be valid, open, and bound for this method to succeed. Return TRUE if the acceptance succeeded and FALSE if it failed.

virtual GPL_Boolean Connect(void)
Connect to another peer. The connection must be valid, open, bound, and connected for this method to succeed. Return TRUE if the connection succeeded and FALSE if it failed.

virtual GPL_Boolean Disconnect(void)
Disconnect from another peer. The connection must be valid, open, bound, and connected for this method to succeed. Return TRUE if the disconnect succeeded and FALSE if it failed.

virtual GPL_Boolean Read(void *buffer, const unsigned long size, unsigned long & length)
Read size bytes from the message connection into buffer. Upon return, length contains the actual number of bytes read. Return TRUE if the read succeeds and FALSE if the read fails.

virtual GPL_Boolean Read(void *buffer, const unsigned long size, const long timeout, unsigned long & length)
Read size bytes from the message connection into buffer, waiting at least timeout milliseconds for the data to be available. Upon return, length contains the actual number of bytes read. Return TRUE if the read succeeds and FALSE if the read fails. If no data arrives before the timeout, FALSE is returned and the value of error.type is DNA_ERROR_NO_DATA_AVAILABLE .

virtual GPL_Boolean Write(void *buffer, const unsigned long size, unsigned long & length)
Write size bytes from buffer onto the message connection. Upon return, length contains the actual number of bytes written. Return TRUE if the read succeeds and FALSE if the write fails.

ENUMERATION

`DNA_CONNECTION_VALID`	The connection is in a valid state.
`DNA_CONNECTION_OPEN`	The connection is open.
`DNA_CONNECTION_BOUND`	The connection is bound.
`DNA_CONNECTION_CONNECTED`	The connection is connected.