GizmoDistribution

gzDistTransportPipe Class Reference

Named pipe transport class. More...

#include <gzDistTransport.h>

Inheritance diagram for gzDistTransportPipe:

gzDistTransportInterface List of all members.

Public Member Functions

 gzDistTransportPipe (const gzString &name, gzBool server=FALSE, gzPipeConnection connection=GZ_PIPE_GLOBAL)
 Constructor.
virtual ~gzDistTransportPipe ()
 Destructor.
gzBool open ()
 Open transport.
gzVoid close ()
 Close transport.
gzBool isOpen () const
 Check if transport is open.
gzBool isConnected ()
 Check if transport is connected.
gzBool isServer () const
 Check if this is a pipe server or a pipe client.
gzBool send (const gzUByte *buffer, gzULong length)
 Send message.
gzInt receive (gzUByte *buffer, gzULong length, gzULong timeout=0)
 Receive message.

Detailed Description

Named pipe transport class.

A named pipe transport can be either local or global and a server or a client. A local named pipe stays within the local host, while a global named pipe is accessible on every host on a local network. A server transport creates a pipe, while a client connects to an existing pipe.

Definition at line 325 of file gzDistTransport.h.


Constructor & Destructor Documentation

gzDistTransportPipe::gzDistTransportPipe const gzString &  name,
gzBool  server = FALSE,
gzPipeConnection  connection = GZ_PIPE_GLOBAL
 

Constructor.

Parameters:
name The unique name of the pipe.
server Server (TRUE) or client (FALSE).
connection Connection type (local or global).


The documentation for this class was generated from the following file:
Documentation for GizmoDistribution generated at Wed Feb 20 11:59:22 2008 by   Saab Training Systems AB, ¸ (c) 2003-and beyond