IAllocateSequencedStreamSockets Class Reference
[Socket allocators, Interfaces, Protected destructors on abstract base classes, Filtering]
Detailed Description
An interface for allocating instances of IPoolableStreamSocket that support sequencing of reads and writes. Before you allocate the first socket you can request that the socket manage buffer sequencing counters for you by requesting a "sequnce id". This id can then be passed to IManageStreamSocketConnectionFilters::ReadCompleted() and IManageStreamSocketConnectionFilters::RequestWrite() calls to have the buffer sequenced using the specified sequnce id. Sockets allocated with this interface automatically support sequencing of the 'primary' byte stream.Public Member Functions | |
| virtual SequenceId | RequestSequenceId (const JetByteTools::Core::_tstring &sequenceName)=0 |
| Can only be called before the first socket is allocated. Allocates a named sequence id that the socket will manage on your behalf. | |
| virtual IPoolableStreamSocket & | AllocateSocket (IPoolableSocketManager &manager, ISocketCallback &callback, SOCKET theSocket)=0 |
| virtual void | ReleaseSocket (IPoolableSocket &socket)=0 |
| Returns the socket to the manager, the manager can pool sockets for later reuse. | |
| virtual DWORD | AbortMyConnections (const IPoolableSocketManager &manager, ConnectionClosureReason reason)=0 |
| Aborts all active sockets that are managed by the supplied manager and returns the number of active sockets that were aborted. | |
| virtual void | DumpMyConnections (const IPoolableSocketManager &manager) const =0 |
| virtual bool | ReleaseSockets ()=0 |
| virtual IIndexedOpaqueUserData::UserDataIndex | RequestUserDataSlot (const _tstring &name)=0 |
| Request a named user data slot and get an index to use in calls to methods on IIndexedOpaqueUserData. | |
| virtual IIndexedOpaqueUserData::UserDataIndex | LockUserDataSlots ()=0 |
| Prevent more user data slots from being allocated. Returns the number of user data slots that have been allocated. | |
Protected Member Functions | |
| virtual | ~IAllocateSequencedStreamSockets () |
| We never delete instances of this interface; you must manage the lifetime of the class that implements it. | |
Constructor & Destructor Documentation
| virtual ~IAllocateSequencedStreamSockets | ( | ) | [protected, virtual] |
We never delete instances of this interface; you must manage the lifetime of the class that implements it.
Member Function Documentation
| virtual SequenceId RequestSequenceId | ( | const JetByteTools::Core::_tstring & | sequenceName | ) | [pure virtual] |
Can only be called before the first socket is allocated. Allocates a named sequence id that the socket will manage on your behalf.
| virtual IPoolableStreamSocket& AllocateSocket | ( | IPoolableSocketManager & | manager, | |
| ISocketCallback & | callback, | |||
| SOCKET | theSocket | |||
| ) | [pure virtual, inherited] |
| virtual void ReleaseSocket | ( | IPoolableSocket & | socket | ) | [pure virtual, inherited] |
Returns the socket to the manager, the manager can pool sockets for later reuse.
Implemented in TSocketAllocator< JetByteTools::Socket::IAllocateDatagramSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateStreamSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateSequencedStreamSockets >, and TSocketAllocator< JetByteTools::Socket::IAllocateDatagramServerSockets >.
| virtual DWORD AbortMyConnections | ( | const IPoolableSocketManager & | manager, | |
| ConnectionClosureReason | reason | |||
| ) | [pure virtual, inherited] |
Aborts all active sockets that are managed by the supplied manager and returns the number of active sockets that were aborted.
Implemented in TSocketAllocator< JetByteTools::Socket::IAllocateDatagramSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateStreamSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateSequencedStreamSockets >, and TSocketAllocator< JetByteTools::Socket::IAllocateDatagramServerSockets >.
| virtual void DumpMyConnections | ( | const IPoolableSocketManager & | manager | ) | const [pure virtual, inherited] |
Implemented in TSocketAllocator< JetByteTools::Socket::IAllocateDatagramSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateStreamSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateSequencedStreamSockets >, and TSocketAllocator< JetByteTools::Socket::IAllocateDatagramServerSockets >.
| virtual bool ReleaseSockets | ( | ) | [pure virtual, inherited] |
Implemented in TSocketAllocator< JetByteTools::Socket::IAllocateDatagramSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateStreamSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateSequencedStreamSockets >, and TSocketAllocator< JetByteTools::Socket::IAllocateDatagramServerSockets >.
| virtual IIndexedOpaqueUserData::UserDataIndex RequestUserDataSlot | ( | const _tstring & | name | ) | [pure virtual, inherited] |
Request a named user data slot and get an index to use in calls to methods on IIndexedOpaqueUserData.
Implemented in CBufferAllocator, TDatagramFilteringHelper, CFilteringStreamSocketConnectionManagerBase, TDatagramFilteringHelper< JetByteTools::Socket::IDatagramSocketConnectionManagerCallback, JetByteTools::Socket::IDatagramSocketConnectionManagerIO, JetByteTools::Socket::IDatagramSocketEx >, TSocketAllocator< JetByteTools::Socket::IAllocateDatagramSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateStreamSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateSequencedStreamSockets >, and TSocketAllocator< JetByteTools::Socket::IAllocateDatagramServerSockets >.
| virtual IIndexedOpaqueUserData::UserDataIndex LockUserDataSlots | ( | ) | [pure virtual, inherited] |
Prevent more user data slots from being allocated. Returns the number of user data slots that have been allocated.
Implemented in CBufferAllocator, TDatagramFilteringHelper, CFilteringStreamSocketConnectionManagerBase, TDatagramFilteringHelper< JetByteTools::Socket::IDatagramSocketConnectionManagerCallback, JetByteTools::Socket::IDatagramSocketConnectionManagerIO, JetByteTools::Socket::IDatagramSocketEx >, TSocketAllocator< JetByteTools::Socket::IAllocateDatagramSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateStreamSockets >, TSocketAllocator< JetByteTools::Socket::IAllocateSequencedStreamSockets >, and TSocketAllocator< JetByteTools::Socket::IAllocateDatagramServerSockets >.
