OSRTSocketOutputStream Class Reference

#include <OSRTSocketOutputStream.h>

Inheritance diagram for OSRTSocketOutputStream:

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
Public Member Functions inherited from OSRTOutputStream
EXTRTMETHOD	OSRTOutputStream ()
EXTRTMETHOD	OSRTOutputStream (OSRTContext *mpContext, OSBOOL attachStream=FALSE)
virtual EXTRTMETHOD	~OSRTOutputStream ()
virtual EXTRTMETHOD int	close ()
virtual EXTRTMETHOD int	flush ()
virtual OSRTCtxtPtr	getContext ()
virtual OSCTXT *	getCtxtPtr ()
virtual char *	getErrorInfo ()
virtual char *	getErrorInfo (char *pBuf, size_t &bufSize)
virtual int	getStatus () const
virtual EXTRTMETHOD OSBOOL	isOpened ()
void	printErrorInfo ()
void	resetErrorInfo ()
virtual EXTRTMETHOD long	write (const OSOCTET *pdata, size_t size)
virtual EXTRTMETHOD long	write (const char *pdata)
Public Member Functions inherited from OSRTStream
virtual EXTRTMETHOD	~OSRTStream ()
int	getStatus () const
OSBOOL	isInitialized ()
void	printErrorInfo ()
void	resetErrorInfo ()

Protected Attributes
OSRTSocket	mSocket
Protected Attributes inherited from OSRTStream
OSRTCtxtHolder	mCtxtHolder
OSBOOL	mbAttached
int	mStatus
int	mInitStatus

Additional Inherited Members
Protected Member Functions inherited from OSRTStream
EXTRTMETHOD	OSRTStream (OSRTContext *pContext, OSBOOL attachStream=FALSE)
EXTRTMETHOD	OSRTStream (OSRTStream &original)
EXTRTMETHOD	OSRTStream ()
EXTRTMETHOD char *	getErrorInfo (size_t *pBufSize)

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

OSRTSocketOutputStream() [1/4]

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

rtxStreamSocketAttach

OSRTSocketOutputStream() [2/4]

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

rtxStreamSocketAttach

OSRTSocketOutputStream() [3/4]

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() [4/4]

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

isA()

virtual OSBOOL OSRTSocketOutputStream::isA ( StreamID  id ) const

inlinevirtual

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:

• OSRTSocketOutputStream.h