The C++ framework for developing highly scalable, high performance servers on Windows platforms.

IStreamSocket Class Reference
[SocketsStream SocketsInterfacesProtected destructors on abstract base classes]

Inheritance diagram for IStreamSocket:
Collaboration diagram for IStreamSocket:

List of all members.


Detailed Description

This interface adds stream socket specific functionality to the IAsyncSocket interface. As you can see that isn't much. This is the interface that you will interact with to access socket functionality when you write a client or server as this is the interface to the socket connection that you are passed when callback events occur on a connection.

Public Types

typedef unsigned long DataLength
typedef unsigned short UserDataIndex

Public Member Functions

virtual void SetNagle (bool nagle) const =0
virtual void SetKeepAlive (Milliseconds time, Milliseconds interval) const =0
virtual void DisableKeepAlive () const =0
virtual DataLength GetReceiveBufferSize () const =0
 Calls getsockopt to get the value of SO_RCVBUF.
virtual DataLength SetReceiveBufferSize (DataLength requestedSize)=0
 Calls setsockopt to set SO_RCVBUF to the value specified and then calls getsockopt to return the buffer size that has actually been set.
virtual DataLength GetSendBufferSize () const =0
 Calls getsockopt to get the value of SO_SNDBUF.
virtual DataLength SetSendBufferSize (DataLength requestedSize)=0
 Calls setsockopt to set SO_SNDBUF to the value specified and then calls getsockopt to return the buffer size that has actually been set.
virtual
JetByteTools::Core::IReentrantLockableObject
GetLock () const =0
 Returns the critical section that is used for locking this socket's data for multi-threaded use.
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 ~IStreamSocket ()
 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]


Constructor & Destructor Documentation

virtual ~IStreamSocket (  )  [protected, virtual]

We never delete instances of this interface; you must manage the lifetime of the class that implements it.


Member Function Documentation

virtual void SetNagle ( bool  nagle  )  const [pure virtual]

virtual void SetKeepAlive ( Milliseconds  time,
Milliseconds  interval 
) const [pure virtual]

virtual void DisableKeepAlive (  )  const [pure virtual]

virtual DataLength GetReceiveBufferSize (  )  const [pure virtual]

Calls getsockopt to get the value of SO_RCVBUF.

virtual DataLength SetReceiveBufferSize ( DataLength  requestedSize  )  [pure virtual]

Calls setsockopt to set SO_RCVBUF to the value specified and then calls getsockopt to return the buffer size that has actually been set.

virtual DataLength GetSendBufferSize (  )  const [pure virtual]

Calls getsockopt to get the value of SO_SNDBUF.

virtual DataLength SetSendBufferSize ( DataLength  requestedSize  )  [pure virtual]

Calls setsockopt to set SO_SNDBUF to the value specified and then calls getsockopt to return the buffer size that has actually been set.

virtual JetByteTools::Core::IReentrantLockableObject& GetLock (  )  const [pure virtual]

Returns the critical section that is used for locking this socket's data for multi-threaded use.

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >.

virtual bool TryRead ( JetByteTools::IO::IBuffer *  pBuffer  )  [pure virtual, inherited]

virtual bool TryWrite ( const char *  pData,
DataLength  dataLength 
) [pure virtual, inherited]

Attempts to write to the connection. Returns false if the connection is closed.

virtual bool TryWrite ( const BYTE pData,
DataLength  dataLength 
) [pure virtual, inherited]

Attempts to write to the connection. Returns false if the connection is closed.

virtual bool AbortConnection ( ConnectionClosureReason  reason  )  [pure virtual, inherited]

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]

CSmartBuffer AllocateCustomSizedBuffer ( IBuffer::BufferSize  bufferSize  )  [override, pure virtual, inherited]

Implements IAllocateBuffer.

Implemented in CNullBufferPool.

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]


Generated on Sun Sep 12 19:10:28 2021 for The Server Framework - v7.4 by doxygen 1.5.3