OSRTSocketOutputStream Class Reference

#include <OSRTSocketOutputStream.h>

Inheritance diagram for OSRTSocketOutputStream:
OSRTOutputStream OSRTStream

List of all members.

Public Member Functions

EXTRTMETHOD OSRTSocketOutputStream (OSRTSocket &socket)
EXTRTMETHOD OSRTSocketOutputStream (OSRTContext *pContext, OSRTSocket &socket)
EXTRTMETHOD OSRTSocketOutputStream (OSRTSOCKET socket, OSBOOL ownership=FALSE)
 OSRTSocketOutputStream (OSRTContext *pContext, OSRTSOCKET socket, OSBOOL ownership=FALSE)
virtual OSBOOL isA (StreamID id) const

Protected Attributes

OSRTSocket mSocket

Detailed Description

Generic socket output stream. This class opens an existing socket for output in binary mode and reads data from it.


Constructor & Destructor Documentation

EXTRTMETHOD OSRTSocketOutputStream::OSRTSocketOutputStream ( OSRTSocket socket  ) 

Creates and initializes a socket output stream using the OSRTSocket instance of socket.

Parameters:
socket Reference to OSRTSocket instance.
See also:
rtxStreamSocketOpen
EXTRTMETHOD OSRTSocketOutputStream::OSRTSocketOutputStream ( OSRTContext pContext,
OSRTSocket socket 
)

Creates and initializes a socket output stream using the OSRTSocket instance of socket.

Parameters:
pContext Pointer to a context to use.
socket Reference to OSRTSocket instance.
See also:
rtxStreamSocketOpen
EXTRTMETHOD OSRTSocketOutputStream::OSRTSocketOutputStream ( OSRTSOCKET  socket,
OSBOOL  ownership = FALSE 
)

Initializes the socket output stream using the socket handle.

Parameters:
socket Handle of the socket.
ownership Indicates ownership of the socket. Set to TRUE to pass ownership to this object instance. The socket will be closed when this object instance is deleted or goes out of scope.
See also:
rtxStreamSocketAttach
OSRTSocketOutputStream::OSRTSocketOutputStream ( OSRTContext pContext,
OSRTSOCKET  socket,
OSBOOL  ownership = FALSE 
)

Initializes the socket output stream using the socket handle.

Parameters:
pContext Pointer to a context to use.
socket Handle of the socket.
ownership Indicates ownership of the socket. Set to TRUE to pass ownership to this object instance. The socket will be closed when this object instance is deleted or goes out of scope.
See also:
rtxStreamSocketAttach

Member Function Documentation

virtual OSBOOL OSRTSocketOutputStream::isA ( StreamID  id  )  const [inline, virtual]

This method is used to query a stream object in order to determine its actual type.

Parameters:
id Enumerated stream identifier
Returns:
True if the stream matches the identifier

Reimplemented from OSRTOutputStream.


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