Home > Support > Documentation

OSRTSocketOutputStream Class Reference

Generic socket output stream. More...

#include <OSRTSocketOutputStream.h>

Inheritance diagram for OSRTSocketOutputStream:

OSRTOutputStream OSRTStream OSRTOutputStreamIF OSRTCtxtHolder OSRTStreamIF OSRTStreamIF OSRTCtxtHolderIF OSRTCtxtHolderIF OSRTCtxtHolderIF List of all members.

Public Member Functions

EXTRTMETHOD OSRTSocketOutputStream (OSRTSocket &socket)
 Creates and initializes a socket output stream using the OSRTSocket instance of socket.
EXTRTMETHOD OSRTSocketOutputStream (OSRTContext *pContext, OSRTSocket &socket)
 Creates and initializes a socket output stream using the OSRTSocket instance of socket.
EXTRTMETHOD OSRTSocketOutputStream (OSRTSOCKET socket, OSBOOL ownership=FALSE)
 Initializes the socket output stream using the socket handle.
 OSRTSocketOutputStream (OSRTContext *pContext, OSRTSOCKET socket, OSBOOL ownership=FALSE)
 Initializes the socket output stream using the socket handle.

Protected Attributes

OSRTSocket mSocket
 a socket

Detailed Description

Generic socket output stream.

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

Definition at line 38 of file OSRTSocketOutputStream.h.

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
The documentation for this class was generated from the following file: