DNA_Binding

dna

1998 12-06

CLASS

DNA_Binding - C++ network peer binding

SYNOPSIS

DNA_Binding implements the behavior of a binding 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 IsOpen(void) const

TRUE

virtual GPL_Boolean IsBound(void) const
Return TRUE if the binding is bound.

virtual DNA_BindingImp *GetBindingImp(void) const
Return the implementation.

virtual DNA_Point *GetSource(void) const
Return the source of the binding.

virtual DNA_Point *GetDestination(void) const
Return the destination of the binding.

virtual void SetImp(DNA_BusImp *i)
Set the implementation of the binding to be i. Note that this may be a pointer to an object of any class derived from DNA_BindingImp, including those derived from DNA_ConnectionImp.

virtual void SetSource(DNA_Point *p)
Set the source of the binding to p. Note that this may be a pointer to an object of any class derived from DNA_Point.

virtual void SetDestination(DNA_Point *p)
Set the destination of the binding to p. Note that this may be a pointer to an object of any class derived from DNA_Point.

virtual void Reset(void)
Reset the binding to an initialized, but unopened and unbound, state.

virtual GPL_Boolean Open(void)
Open the binding. Return TRUE if the opening succeeded and FALSE if it failed.

virtual GPL_Boolean Bind(void)
Perform the binding between the source, specified by point, and the destination, previously specified with GetDestination(). Return TRUE if the binding succeeded and FALSE if it failed.

virtual GPL_Boolean Close(void)
Close the binding. Return TRUE if the closing 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 binding 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 binding 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 binding. Upon return, length contains the actual number of bytes written. Return TRUE if the read succeeds and FALSE if the write fails.

ENUMERATION

`DNA_BINDING_VALID`	The binding is in a valid state.
`DNA_BINDING_OPEN`	The binding is open.
`DNA_BINDING_BOUND`	The binding is bound.