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

CStreamSocketServerExCallback Class Reference

Inheritance diagram for CStreamSocketServerExCallback:
Collaboration diagram for CStreamSocketServerExCallback:

List of all members.

Public Member Functions

void OnIncrementPendingReceives (DWORD pendingReceives) override
 Called when the number of pending receieves has increased. The value supplied is the new number of pending receives.
void OnDecrementPendingReceives (DWORD pendingReceives) override
 Called when the number of pending receieves has decreased. The value supplied is the new number of pending receives.
void OnStartAcceptingConnections () override
 Called when the server starts accepting connections.
void OnStopAcceptingConnections () override
 Called when the server stops accepting connections.
void OnAcceptError (DWORD lastError) override
 Called when there is an error from the system call that the server makes to accept new connections. Not a lot you can do except log the error message... Possibly shouldn't be exposed to client code?
void OnSocketCreated (SOCKET s) override
 Called just after a socket is created. Allows you to adjust socket options that aren't othewise accessible via the framework. Use with care.
void OnPreOutgoingConnect (JetByteTools::Core::IIndexedOpaqueUserData &userData, const JetByteTools::Socket::IAddress &address, const void *pUserData) override
 Called just before an outgoing connection is established, i.e. a 'client' connection. The userData is the user data associated with the socket that will attempt the connection. The address is the address that the socket will attempt to connect to and the pointer to user data is whatever was passed in as user data to the Connect(), ConnectNoThrow(), AsyncConnect() or AsyncConnectNoThrow() call. This is usually used to slot the pointer to user data into the socket's user data store before the connection is attempted; thus passing data from the connect call site to the connection establishment or failure callback and beyond.
void OnConnectionEstablished (JetByteTools::Socket::IStreamSocket &socket, const JetByteTools::Socket::IAddress &address) override
 Called when a connection is established. The address is the address that the socket is connected to. This is where you are expected to issue your first Read() or Write() call on a connection, if you don't and don't increase the reference count of the socket in some other way then the socket will close automatically.
void OnOutgoingConnectionFailed (JetByteTools::Socket::IStreamSocket &socket, const JetByteTools::Socket::IAddress &address, DWORD lastError) override
 Called when an outgoing async or sync no throw connection fails. The address is the address that we were attempting to connect to. Note that sync connections attempts that can throw exceptions do not result in this callback being called when they fail to connect.
void OnSocketReleased (JetByteTools::Core::IIndexedOpaqueUserData &userData) override
 Called when a connection is released back to the allocator. This is guarenteed to be the last event that happens on an active socket. The socket is dead at this point and you're passed the userData that was related to it so that you can perform some final cleanup if required. Note that you should not assume that you can use the address of the user data object for anything. Due to how the socket object's inheritance works this particular interface is different to the instance of IIndexedOpaqueUserData that you can cast to from the IStreamSocket interface that you're given in all of the other callbacks and the address of this user data will be different to the address of the user data passed in OnPreOutgoingConnect() for the same socket. Note that you can, of course, access the socket's user data store via the interface, you just can't use the address of the interface for anything useful.
void OnReadCompleted (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer) override
 Called when an asynchronous read completes. This is where you are given the data that has been received on the connection and where your business logic would usually be expected to start dealing with the data. You are generally expected to issue another Read() before this call completes, if you don't and don't increase the reference count of the socket in some other way then the socket will close automatically.
void OnReadCompletionError (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer, DWORD lastError) override
 Called when an asynchronous read completes with an error.
void OnReadOOBCompleted (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer) override
 Called when an asynchronous out of band data read completes.
void OnWriteCompleted (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer) override
 Called when an asynchronous write completes. There's not a great deal that needs to be done here. Note that this is called when the data in your buffer has been handed off to the local TCP stack to send, it does not, in any way, imply any more than that. See here for more details.
void OnWriteCompletionError (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer, DWORD lastError) override
 Called when an asynchronous write completes with an error. In certain low resource situations you may find that the write can complete and not all of the data has been sent, but there's probably not a great deal that you can do to fix things...
void OnMaximumConnections () override
 Called when the maximum allowed number of connections is reached and no more new connections will be accepted by the server. See ILimitConnections for details on limiting connections.
void OnAllConnectionsAborted (DWORD numberOfConnectionsAborted) override
 Called when connections have been aborted due to AbortAllConnections() being called either explicitly, or implicitly as part of a shutdown sequence.
void OnShutdownInitiated () override
 Called when the connection manager starts to shutdown.
void OnShutdownComplete () override
 Called when the connection manager has finished its shutdown process and all active connections have been released.
void OnConnectionClientClose (JetByteTools::Socket::IStreamSocket &socket) override
 Called when the 'read side' of the connection is closed by the remote end. The remote end of the connection can no longer send data to you as it has issued a shutdown() call and shut down at least the write side of its socket. This means that you can no longer read from the connection but you may still be able to write to the connection.
void OnConnectionReset (JetByteTools::Socket::IStreamSocket &socket, DWORD lastError) override
 Called when the connection is reset.
void OnConnectionClosure (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::Socket::ConnectionClosureReason reason) override
 Called when the connection is closed.
void OnConnectionClosed (JetByteTools::Socket::IStreamSocket &socket) override
 Called when the connection is closed. Note that this callback is purely for backwards compatibility with pre v6.2 code. You will get both an OnConnectionClosure() callback with a closure reason and then an OnConnectionClosed() without a reason. OnConnectionClosed() MAY be removed in a future release of the framework.
void OnError (const JetByteTools::Core::_tstring &message) override
 Called when there is an error which is not related to a particular connection (such as an exception thrown whilst handling an I/O operation or something...). Not a lot you can do except log the error message... Possibly shouldn't be exposed to client code?
void OnError (const JetByteTools::Core::_tstring &message, DWORD lastError) override
virtual bool OnReadCompletionErrorMayNotBeFatalConnectionError (IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer, const DWORD lastError)
 Called when an asynchronous read completes with an error. Override this version if you want to be able to continue the connection if a read error occurs, otherwise connections are aborted on any read error.
virtual bool OnWriteCompletionErrorMayNotBeFatalConnectionError (IStreamSocket &socket, JetByteTools::IO::CSmartBuffer &buffer, const DWORD lastError)
 Called when an asynchronous write completes with an error. In certain low resource situations you may find that the write can complete and not all of the data has been sent, but there's probably not a great deal that you can do to fix things... Override this version if you want to be able to continue the connection if a write error occurs, otherwise connections are aborted on any write error.


Member Function Documentation

void OnIncrementPendingReceives ( DWORD  pendingReceives  )  [override, virtual]

Called when the number of pending receieves has increased. The value supplied is the new number of pending receives.

Implements IStreamSocketServerExCallback.

void OnDecrementPendingReceives ( DWORD  pendingReceives  )  [override, virtual]

Called when the number of pending receieves has decreased. The value supplied is the new number of pending receives.

Implements IStreamSocketServerExCallback.

void OnStartAcceptingConnections (  )  [override, virtual]

Called when the server starts accepting connections.

Implements IStreamSocketServerCallback.

void OnStopAcceptingConnections (  )  [override, virtual]

Called when the server stops accepting connections.

Implements IStreamSocketServerCallback.

void OnAcceptError ( DWORD  lastError  )  [override, virtual]

Called when there is an error from the system call that the server makes to accept new connections. Not a lot you can do except log the error message... Possibly shouldn't be exposed to client code?

Implements IStreamSocketServerCallback.

void OnSocketCreated ( SOCKET  s  )  [override, virtual]

Called just after a socket is created. Allows you to adjust socket options that aren't othewise accessible via the framework. Use with care.

Implements IStreamSocketConnectionManagerCallback.

void OnPreOutgoingConnect ( JetByteTools::Core::IIndexedOpaqueUserData userData,
const JetByteTools::Socket::IAddress address,
const void *  pUserData 
) [override, virtual]

Called just before an outgoing connection is established, i.e. a 'client' connection. The userData is the user data associated with the socket that will attempt the connection. The address is the address that the socket will attempt to connect to and the pointer to user data is whatever was passed in as user data to the Connect(), ConnectNoThrow(), AsyncConnect() or AsyncConnectNoThrow() call. This is usually used to slot the pointer to user data into the socket's user data store before the connection is attempted; thus passing data from the connect call site to the connection establishment or failure callback and beyond.

Implements IStreamSocketConnectionManagerCallback.

void OnConnectionEstablished ( JetByteTools::Socket::IStreamSocket socket,
const JetByteTools::Socket::IAddress address 
) [override, virtual]

Called when a connection is established. The address is the address that the socket is connected to. This is where you are expected to issue your first Read() or Write() call on a connection, if you don't and don't increase the reference count of the socket in some other way then the socket will close automatically.

Implements IStreamSocketConnectionManagerCallback.

void OnOutgoingConnectionFailed ( JetByteTools::Socket::IStreamSocket socket,
const JetByteTools::Socket::IAddress address,
DWORD  lastError 
) [override, virtual]

Called when an outgoing async or sync no throw connection fails. The address is the address that we were attempting to connect to. Note that sync connections attempts that can throw exceptions do not result in this callback being called when they fail to connect.

Implements IStreamSocketConnectionManagerCallback.

void OnSocketReleased ( JetByteTools::Core::IIndexedOpaqueUserData userData  )  [override, virtual]

Called when a connection is released back to the allocator. This is guarenteed to be the last event that happens on an active socket. The socket is dead at this point and you're passed the userData that was related to it so that you can perform some final cleanup if required. Note that you should not assume that you can use the address of the user data object for anything. Due to how the socket object's inheritance works this particular interface is different to the instance of IIndexedOpaqueUserData that you can cast to from the IStreamSocket interface that you're given in all of the other callbacks and the address of this user data will be different to the address of the user data passed in OnPreOutgoingConnect() for the same socket. Note that you can, of course, access the socket's user data store via the interface, you just can't use the address of the interface for anything useful.

Implements IStreamSocketConnectionManagerCallback.

void OnReadCompleted ( JetByteTools::Socket::IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer 
) [override, virtual]

Called when an asynchronous read completes. This is where you are given the data that has been received on the connection and where your business logic would usually be expected to start dealing with the data. You are generally expected to issue another Read() before this call completes, if you don't and don't increase the reference count of the socket in some other way then the socket will close automatically.

Implements IStreamSocketConnectionManagerCallback.

void OnReadCompletionError ( JetByteTools::Socket::IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer,
DWORD  lastError 
) [override, virtual]

Called when an asynchronous read completes with an error.

Implements IStreamSocketConnectionManagerCallback.

void OnReadOOBCompleted ( JetByteTools::Socket::IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer 
) [override, virtual]

Called when an asynchronous out of band data read completes.

Implements IStreamSocketConnectionManagerCallback.

void OnWriteCompleted ( JetByteTools::Socket::IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer 
) [override, virtual]

Called when an asynchronous write completes. There's not a great deal that needs to be done here. Note that this is called when the data in your buffer has been handed off to the local TCP stack to send, it does not, in any way, imply any more than that. See here for more details.

Implements IStreamSocketConnectionManagerCallback.

void OnWriteCompletionError ( JetByteTools::Socket::IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer,
DWORD  lastError 
) [override, virtual]

Called when an asynchronous write completes with an error. In certain low resource situations you may find that the write can complete and not all of the data has been sent, but there's probably not a great deal that you can do to fix things...

Implements IStreamSocketConnectionManagerCallback.

void OnMaximumConnections (  )  [override, virtual]

Called when the maximum allowed number of connections is reached and no more new connections will be accepted by the server. See ILimitConnections for details on limiting connections.

Implements IStreamSocketConnectionManagerCallback.

void OnAllConnectionsAborted ( DWORD  numberOfConnectionsAborted  )  [override, virtual]

Called when connections have been aborted due to AbortAllConnections() being called either explicitly, or implicitly as part of a shutdown sequence.

Implements IStreamSocketConnectionManagerCallback.

void OnShutdownInitiated (  )  [override, virtual]

Called when the connection manager starts to shutdown.

Implements IStreamSocketConnectionManagerCallback.

void OnShutdownComplete (  )  [override, virtual]

Called when the connection manager has finished its shutdown process and all active connections have been released.

Implements IStreamSocketConnectionManagerCallback.

void OnConnectionClientClose ( JetByteTools::Socket::IStreamSocket socket  )  [override, virtual]

Called when the 'read side' of the connection is closed by the remote end. The remote end of the connection can no longer send data to you as it has issued a shutdown() call and shut down at least the write side of its socket. This means that you can no longer read from the connection but you may still be able to write to the connection.

Implements IStreamSocketCallback.

void OnConnectionReset ( JetByteTools::Socket::IStreamSocket socket,
DWORD  lastError 
) [override, virtual]

Called when the connection is reset.

Implements IStreamSocketCallback.

void OnConnectionClosure ( JetByteTools::Socket::IStreamSocket socket,
JetByteTools::Socket::ConnectionClosureReason  reason 
) [override, virtual]

Called when the connection is closed.

Implements IStreamSocketCallback.

void OnConnectionClosed ( JetByteTools::Socket::IStreamSocket socket  )  [override, virtual]

Called when the connection is closed. Note that this callback is purely for backwards compatibility with pre v6.2 code. You will get both an OnConnectionClosure() callback with a closure reason and then an OnConnectionClosed() without a reason. OnConnectionClosed() MAY be removed in a future release of the framework.

Implements IStreamSocketCallback.

void OnError ( const JetByteTools::Core::_tstring message  )  [override, virtual]

Called when there is an error which is not related to a particular connection (such as an exception thrown whilst handling an I/O operation or something...). Not a lot you can do except log the error message... Possibly shouldn't be exposed to client code?

Implements ISocketCallback.

void OnError ( const JetByteTools::Core::_tstring message,
DWORD  lastError 
) [override, virtual]

Implements ISocketCallback.

virtual bool OnReadCompletionErrorMayNotBeFatalConnectionError ( IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer,
const DWORD  lastError 
) [inline, virtual, inherited]

Called when an asynchronous read completes with an error. Override this version if you want to be able to continue the connection if a read error occurs, otherwise connections are aborted on any read error.

virtual bool OnWriteCompletionErrorMayNotBeFatalConnectionError ( IStreamSocket socket,
JetByteTools::IO::CSmartBuffer buffer,
const DWORD  lastError 
) [inline, virtual, inherited]

Called when an asynchronous write completes with an error. In certain low resource situations you may find that the write can complete and not all of the data has been sent, but there's probably not a great deal that you can do to fix things... Override this version if you want to be able to continue the connection if a write error occurs, otherwise connections are aborted on any write error.


Generated on Thu Jan 28 19:39:19 2021 for The Server Framework - v7.1 by doxygen 1.5.3