gzDistTransportInterface Class Reference

Remote distribution transport interface. More...

#include <gzDistTransport.h>

Inheritance diagram for gzDistTransportInterface:

List of all members.

Public Member Functions
	gzDistTransportInterface ()
	Default constructor.
virtual	~gzDistTransportInterface ()
	Destructor.
virtual gzBool	open ()=0
	Open transport.
virtual gzVoid	close ()=0
	Close transport.
virtual gzBool	isOpen () const =0
	Check if transport is open.
virtual gzBool	isConnected ()=0
	Check if transport is connected.
virtual gzBool	send (const gzUByte *buffer, gzULong length)=0
	Send message.
virtual gzInt	receive (gzUByte *buffer, gzULong length, gzULong timeout=0)=0
	Receive message.

---

Detailed Description

Remote distribution transport interface.

Base class for distribution transports.

Definition at line 60 of file gzDistTransport.h.

---

Member Function Documentation

virtual gzBool gzDistTransportInterface::send (  const gzUByte *  buffer, gzULong  length )  [pure virtual]

Send message. Parameters: buffer  Buffer containing the message to send. length  Length of the message (number of bytes). Implemented in gzDistTransportUDP, gzDistTransportTCP, and gzDistTransportPipe.

virtual gzInt gzDistTransportInterface::receive (  gzUByte *  buffer, gzULong  length, gzULong  timeout = 0 )  [pure virtual]

Receive message. Parameters: buffer  The buffer to receive data to. length  Length of the buffer (number of bytes). timeout  Milliseconds to wait for a message to arrive. Return values: >0  Length of the received message (number of bytes). ==0  No message received. <0  Error. Implemented in gzDistTransportUDP, gzDistTransportTCP, and gzDistTransportPipe.

---

The documentation for this class was generated from the following file:

• gzDistTransport.h

---