#include <OSRTSocketInputStream.h>
Inheritance diagram for OSRTSocketInputStream:
Public Member Functions | |
| EXTRTMETHOD | OSRTSocketInputStream (OSRTSocket &socket) |
| EXTRTMETHOD | OSRTSocketInputStream (OSRTContext *pContext, OSRTSocket &socket) |
| EXTRTMETHOD | OSRTSocketInputStream (OSRTSOCKET socket, OSBOOL ownership=FALSE) |
| OSRTSocketInputStream (OSRTContext *pContext, OSRTSOCKET socket, OSBOOL ownership=FALSE) | |
| virtual OSBOOL | isA (StreamID id) const |
 Public Member Functions inherited from OSRTInputStream | |
| EXTRTMETHOD | OSRTInputStream () |
| EXTRTMETHOD | OSRTInputStream (OSRTContext *mpContext, OSBOOL attachStream=FALSE) |
| virtual EXTRTMETHOD | ~OSRTInputStream () |
| virtual EXTRTMETHOD int | close () |
| virtual EXTRTMETHOD size_t | currentPos () |
| virtual EXTRTMETHOD int | flush () |
| virtual OSRTCtxtPtr | getContext () |
| virtual OSCTXT * | getCtxtPtr () |
| virtual char * | getErrorInfo () |
| virtual char * | getErrorInfo (char *pBuf, size_t &bufSize) |
| virtual int | getPosition (size_t *ppos) |
| virtual int | getStatus () const |
| virtual EXTRTMETHOD OSBOOL | isOpened () |
| virtual EXTRTMETHOD OSBOOL | markSupported () |
| virtual EXTRTMETHOD int | mark (size_t readAheadLimit) |
| void | printErrorInfo () |
| void | resetErrorInfo () |
| virtual EXTRTMETHOD long | read (OSOCTET *pDestBuf, size_t maxToRead) |
| virtual EXTRTMETHOD long | readBlocking (OSOCTET *pDestBuf, size_t toReadBytes) |
| virtual EXTRTMETHOD int | reset () |
| virtual int | setPosition (size_t pos) |
| virtual EXTRTMETHOD int | skip (size_t n) |
| 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 input stream. This class opens an existing socket for input in binary mode and reads data from it.
Constructor & Destructor Documentation
◆ OSRTSocketInputStream() [1/4]
| 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
◆ OSRTSocketInputStream() [2/4]
| 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
◆ OSRTSocketInputStream() [3/4]
| 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() [4/4]
| 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
◆ isA()
|
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 OSRTInputStream.
The documentation for this class was generated from the following file: