IAsyncSocket Class Reference
[Sockets, Interfaces, Protected destructors on abstract base classes]
Detailed Description
An interface to the functionality common to all asynchronous sockets. The "Try" functions add to the functions from JetByteTools::IO::IAsyncIOStream by adding versions that return false on failure rather than by throwing an exception.Public Types | |
| typedef unsigned long | DataLength |
| typedef unsigned short | UserDataIndex |
Public Member Functions | |
| virtual const std::string & | GetIdentifierA () const =0 |
| virtual JetByteTools::Core::_tstring | GetIdentifier () const =0 |
| virtual bool | TryRead ()=0 |
| Attempts to read from the connection. Returns false if the connection is closed. | |
| virtual bool | TryRead (JetByteTools::IO::CSmartBuffer &buffer)=0 |
| Attempts to read from the connection. Returns false if the connection is closed. Note that this CAN throw an exception if the supplied buffer doesn't have any space left in it. | |
| virtual bool | TryRead (JetByteTools::IO::IBuffer *pBuffer)=0 |
| Attempts to read from the connection. Returns false if the connection is closed. Note that this CAN throw an exception if the supplied buffer doesn't have any space left in it. | |
| virtual bool | TryWrite (const char *pData, DataLength dataLength)=0 |
| Attempts to write to the connection. Returns false if the connection is closed. | |
| virtual bool | TryWrite (const BYTE *pData, DataLength dataLength)=0 |
| Attempts to write to the connection. Returns false if the connection is closed. | |
| virtual bool | TryWrite (JetByteTools::IO::CSmartBuffer &buffer)=0 |
| Attempts to write to the connection. Returns false if the connection is closed. | |
| virtual bool | TryWrite (JetByteTools::IO::IIterateableBufferChain &buffers)=0 |
| Attempts to write to the connection. Returns false if the connection is closed. | |
| virtual void | Shutdown ()=0 |
| virtual void | Shutdown (ShutdownHow how)=0 |
| virtual bool | AbortConnection ()=0 |
| virtual bool | AbortConnection (ConnectionClosureReason reason)=0 |
| virtual CAddress | GetLocalAddress () const =0 |
| virtual CAddress | GetRemoteAddress () const =0 |
| virtual void | AddRef ()=0 |
| virtual void | Release ()=0 |
| virtual ConnectionDirection | GetConnectionDirection () const =0 |
| virtual void | Read ()=0 |
| virtual void | Read (CSmartBuffer &buffer)=0 |
| virtual void | Read (IBuffer *pBuffer)=0 |
| virtual void | Write (const char *pData, DataLength dataLength)=0 |
| virtual void | Write (const BYTE *pData, DataLength dataLength)=0 |
| virtual void | Write (CSmartBuffer &buffer)=0 |
| virtual void | Write (IIterateableBufferChain &buffers)=0 |
| virtual void * | GetUserPointer (UserDataIndex index) const =0 |
| Access the data stored at the specified index as a void pointer. | |
| virtual void | SetUserPointer (UserDataIndex index, void *pData)=0 |
| Update the data stored at the specified index as a void pointer. | |
| virtual ULONG_PTR | GetUserData (UserDataIndex index) const =0 |
| Access the data stored at the specified index as an unsigned long. | |
| virtual void | SetUserData (UserDataIndex index, ULONG_PTR data)=0 |
| Update the data stored at the specified index as an unsigned long. | |
| CSmartBuffer | Allocate () override=0 |
| Allocate an instance of IBuffer, remember to call Release() on it when you're done with it. | |
| virtual CSmartBuffer | Allocate (IAllocateBuffer &allocator)=0 |
| CSmartBuffer | AllocateCustomSizedBuffer (IBuffer::BufferSize bufferSize) override=0 |
| virtual CSmartBuffer | AllocateCustomSizedBuffer (IAllocateBuffer &allocator, IBuffer::BufferSize bufferSize)=0 |
| virtual void | AddBufferToPool (IBuffer &buffer)=0 |
Static Public Attributes | |
| static JETBYTE_CONSTEXPR UserDataIndex | InvalidUserDataIndex = 0xFFFF |
Protected Member Functions | |
| virtual | ~IAsyncSocket () |
| We never delete instances of this interface; you must manage the lifetime of the class that implements it. | |
Member Typedef Documentation
typedef unsigned long DataLength [inherited] |
typedef unsigned short UserDataIndex [inherited] |
Constructor & Destructor Documentation
| virtual ~IAsyncSocket | ( | ) | [protected, virtual] |
We never delete instances of this interface; you must manage the lifetime of the class that implements it.
Member Function Documentation
| virtual const std::string& GetIdentifierA | ( | ) | const [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual JetByteTools::Core::_tstring GetIdentifier | ( | ) | const [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool TryRead | ( | ) | [pure virtual] |
Attempts to read from the connection. Returns false if the connection is closed.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool TryRead | ( | JetByteTools::IO::CSmartBuffer & | buffer | ) | [pure virtual] |
Attempts to read from the connection. Returns false if the connection is closed. Note that this CAN throw an exception if the supplied buffer doesn't have any space left in it.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool TryRead | ( | JetByteTools::IO::IBuffer * | pBuffer | ) | [pure virtual] |
Attempts to read from the connection. Returns false if the connection is closed. Note that this CAN throw an exception if the supplied buffer doesn't have any space left in it.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool TryWrite | ( | const char * | pData, | |
| DataLength | dataLength | |||
| ) | [pure virtual] |
Attempts to write to the connection. Returns false if the connection is closed.
| virtual bool TryWrite | ( | const BYTE * | pData, | |
| DataLength | dataLength | |||
| ) | [pure virtual] |
Attempts to write to the connection. Returns false if the connection is closed.
| virtual bool TryWrite | ( | JetByteTools::IO::CSmartBuffer & | buffer | ) | [pure virtual] |
Attempts to write to the connection. Returns false if the connection is closed.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool TryWrite | ( | JetByteTools::IO::IIterateableBufferChain & | buffers | ) | [pure virtual] |
Attempts to write to the connection. Returns false if the connection is closed.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Shutdown | ( | ) | [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Shutdown | ( | ShutdownHow | how | ) | [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool AbortConnection | ( | ) | [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual bool AbortConnection | ( | ConnectionClosureReason | reason | ) | [pure virtual] |
| virtual CAddress GetLocalAddress | ( | ) | const [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual CAddress GetRemoteAddress | ( | ) | const [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void AddRef | ( | ) | [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Release | ( | ) | [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual ConnectionDirection GetConnectionDirection | ( | ) | const [pure virtual] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Read | ( | ) | [pure virtual, inherited] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Read | ( | CSmartBuffer & | buffer | ) | [pure virtual, inherited] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Read | ( | IBuffer * | pBuffer | ) | [pure virtual, inherited] |
| virtual void Write | ( | const char * | pData, | |
| DataLength | dataLength | |||
| ) | [pure virtual, inherited] |
| virtual void Write | ( | const BYTE * | pData, | |
| DataLength | dataLength | |||
| ) | [pure virtual, inherited] |
| virtual void Write | ( | CSmartBuffer & | buffer | ) | [pure virtual, inherited] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void Write | ( | IIterateableBufferChain & | buffers | ) | [pure virtual, inherited] |
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >.
| virtual void* GetUserPointer | ( | UserDataIndex | index | ) | const [pure virtual, inherited] |
Access the data stored at the specified index as a void pointer.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.
| virtual void SetUserPointer | ( | UserDataIndex | index, | |
| void * | pData | |||
| ) | [pure virtual, inherited] |
Update the data stored at the specified index as a void pointer.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.
| virtual ULONG_PTR GetUserData | ( | UserDataIndex | index | ) | const [pure virtual, inherited] |
Access the data stored at the specified index as an unsigned long.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.
| virtual void SetUserData | ( | UserDataIndex | index, | |
| ULONG_PTR | data | |||
| ) | [pure virtual, inherited] |
Update the data stored at the specified index as an unsigned long.
Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.
| CSmartBuffer Allocate | ( | ) | [override, pure virtual, inherited] |
Allocate an instance of IBuffer, remember to call Release() on it when you're done with it.
Implements IAllocateBuffer.
Implemented in CNullBufferPool, TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >, and TWebSocketBase< JetByteTools::WebSocket::HyBi::IWebSocket >.
| virtual CSmartBuffer Allocate | ( | IAllocateBuffer & | allocator | ) | [pure virtual, inherited] |
Implemented in CNullBufferPool, TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, TAsyncSocket< JetByteTools::Socket::TMulticastDatagramHelper< JetByteTools::Socket::IPoolableDatagramSocket >, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >, and TWebSocketBase< JetByteTools::WebSocket::HyBi::IWebSocket >.
| CSmartBuffer AllocateCustomSizedBuffer | ( | IBuffer::BufferSize | bufferSize | ) | [override, pure virtual, inherited] |
| virtual CSmartBuffer AllocateCustomSizedBuffer | ( | IAllocateBuffer & | allocator, | |
| IBuffer::BufferSize | bufferSize | |||
| ) | [pure virtual, inherited] |
Implemented in CNullBufferPool.
| virtual void AddBufferToPool | ( | IBuffer & | buffer | ) | [pure virtual, inherited] |
Implemented in CNullBufferPool.
Member Data Documentation
JETBYTE_CONSTEXPR UserDataIndex InvalidUserDataIndex = 0xFFFF [static, inherited] |
