OSRTSocketInputStream Class Reference

Generic socket input stream. More...

#include <OSRTSocketInputStream.h>

Inheritance diagram for OSRTSocketInputStream:
OSRTInputStream OSRTStream

List of all members.

Public Member Functions

EXTRTMETHOD OSRTSocketInputStream (OSRTSocket &socket)
 Creates and initializes a socket input stream using the OSRTSocket instance of socket.
EXTRTMETHOD OSRTSocketInputStream (OSRTContext *pContext, OSRTSocket &socket)
 Creates and initializes a socket input stream using the OSRTSocket instance of socket.
EXTRTMETHOD OSRTSocketInputStream (OSRTSOCKET socket, OSBOOL ownership=FALSE)
 Creates and initializes the socket input stream using the socket handle.
 OSRTSocketInputStream (OSRTContext *pContext, OSRTSOCKET socket, OSBOOL ownership=FALSE)
 Creates and initializes the socket input stream using the socket handle.
virtual OSBOOL isA (StreamID id) const
 This method is used to query a stream object in order to determine its actual type.

Protected Attributes

OSRTSocket mSocket
 a socket

Detailed Description

Generic socket input stream.

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

Definition at line 40 of file OSRTSocketInputStream.h.


Constructor & Destructor Documentation

EXTRTMETHOD OSRTSocketInputStream::OSRTSocketInputStream ( OSRTSocket socket  ) 

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

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

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

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

Creates and initializes the socket input 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
OSRTSocketInputStream::OSRTSocketInputStream ( OSRTContext pContext,
OSRTSOCKET  socket,
OSBOOL  ownership = FALSE 
)

Creates and initializes the socket input 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 OSRTSocketInputStream::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 OSRTInputStream.

Definition at line 105 of file OSRTSocketInputStream.h.


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