IDatagramSocketConnectionManagerCallback Class Reference
[Datagram Sockets, Connection managers, Callback events, Interfaces, Protected destructors on abstract base classes]
Detailed Description
The connection manager and socket server callback interfaces are composed from more specific interfaces using inheritance. This is purely to allow the framework to work in terms of the narrowest interface internally and does not affect the user of the code. Effectively the first interface that the user would wish to implement is at the IXXXConnectionManagerCallback level and above.Public Member Functions | |
| virtual void | OnSocketCreated (SOCKET s)=0 |
| Called just after a socket is created. Allows you to adjust socket options that aren't othewise accessible via the framework. Use with care. | |
| virtual void | OnBindCompleted (IDatagramSocket &socket)=0 |
| Called when a socket has been bound to a local address, such as after a Bind() call completes, or when a SendTo() has been issued for the first time, or when a Connect() has completed. | |
| virtual void | OnPreOutgoingConnect (JetByteTools::Core::IIndexedOpaqueUserData &userData, const IAddress &address, const void *pUserData)=0 |
| 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() or AsyncConnect() call. This is usually used to slot the pointer to user data into the sockets 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. | |
| virtual void | OnConnectionEstablished (IDatagramSocket &socket, const IAddress &address)=0 |
| 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. | |
| virtual void | OnOutgoingConnectionFailed (IDatagramSocket &socket, const IAddress &address, DWORD lastError)=0 |
| 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. | |
| virtual void | OnSocketReleased (JetByteTools::Core::IIndexedOpaqueUserData &userData)=0 |
| 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. | |
| virtual void | OnReadCompleted (IDatagramSocket &socket, JetByteTools::IO::CSmartBuffer &buffer)=0 |
| 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. | |
| virtual void | OnReadCompletionError (IDatagramSocket &socket, JetByteTools::IO::CSmartBuffer &buffer, DWORD lastError)=0 |
| Called when an asynchronous read completes with an error. | |
| virtual void | OnWriteCompleted (IDatagramSocket &socket, JetByteTools::IO::CSmartBuffer &buffer)=0 |
| Called when an asynchronous write completes. There's not a great deal that needs to be done here. | |
| virtual void | OnWriteCompletionError (IDatagramSocket &socket, JetByteTools::IO::CSmartBuffer &buffer, DWORD lastError)=0 |
| 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... | |
| virtual void | OnRecvFromCompleted (IDatagramSocket &socket, const IAddress &address, JetByteTools::IO::CSmartBuffer &buffer)=0 |
| Called when an asynchronous recv from 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. | |
| virtual void | OnRecvFromCompletionError (IDatagramSocket &socket, const IAddress &address, JetByteTools::IO::CSmartBuffer &buffer, DWORD lastError)=0 |
| Called when an asynchronous recv from completes with an error. | |
| virtual void | OnSendToCompleted (IDatagramSocket &socket, const IAddress &address, JetByteTools::IO::CSmartBuffer &buffer)=0 |
| Called when an asynchronous send to completes. There's not a great deal that needs to be done here. | |
| virtual void | OnSendToCompletionError (IDatagramSocket &socket, const IAddress &address, JetByteTools::IO::CSmartBuffer &buffer, DWORD lastError)=0 |
| Called when an asynchronous send to completes with an error. In certain low resource situations you may find that the send to 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... | |
| virtual void | OnMaximumConnections ()=0 |
| 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. | |
| virtual void | OnAllConnectionsAborted (DWORD numberOfConnectionsAborted)=0 |
| Called when connections have been aborted due to AbortAllConnections() being called either explicitly, or implicitly as part of a shutdown sequence. | |
| virtual void | OnShutdownInitiated ()=0 |
| Called when the connection manager starts to shutdown. | |
| virtual void | OnShutdownComplete ()=0 |
| Called when the connection manager has finished its shutdown process and all active connections have been released. | |
| virtual void | OnConnectionReset (IDatagramSocket &socket, DWORD lastError)=0 |
| Called when the connection is reset. | |
| virtual void | OnConnectionClosure (IDatagramSocket &socket, ConnectionClosureReason reason)=0 |
| Called when the connection is closed. | |
| virtual void | OnConnectionClosed (IDatagramSocket &socket)=0 |
| Called when the connection is closed. 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. | |
| virtual void | OnError (const JetByteTools::Core::_tstring &message)=0 |
| 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? | |
| virtual void | OnError (const JetByteTools::Core::_tstring &message, DWORD lastError)=0 |
Protected Member Functions | |
| virtual | ~IDatagramSocketConnectionManagerCallback () |
Constructor & Destructor Documentation
| virtual ~IDatagramSocketConnectionManagerCallback | ( | ) | [protected, virtual] |
Member Function Documentation
| virtual void OnSocketCreated | ( | SOCKET | s | ) | [pure 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnBindCompleted | ( | IDatagramSocket & | socket | ) | [pure virtual] |
Called when a socket has been bound to a local address, such as after a Bind() call completes, or when a SendTo() has been issued for the first time, or when a Connect() has completed.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnPreOutgoingConnect | ( | JetByteTools::Core::IIndexedOpaqueUserData & | userData, | |
| const IAddress & | address, | |||
| const void * | pUserData | |||
| ) | [pure 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() or AsyncConnect() call. This is usually used to slot the pointer to user data into the sockets 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnConnectionEstablished | ( | IDatagramSocket & | socket, | |
| const IAddress & | address | |||
| ) | [pure 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnOutgoingConnectionFailed | ( | IDatagramSocket & | socket, | |
| const IAddress & | address, | |||
| DWORD | lastError | |||
| ) | [pure 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnSocketReleased | ( | JetByteTools::Core::IIndexedOpaqueUserData & | userData | ) | [pure 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnReadCompleted | ( | IDatagramSocket & | socket, | |
| JetByteTools::IO::CSmartBuffer & | buffer | |||
| ) | [pure 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.
Implemented in CDatagramSocketConnectionManagerCallback, CUDPConnectionCreator, and CDatagramSocketConnectionManagerCallback.
| virtual void OnReadCompletionError | ( | IDatagramSocket & | socket, | |
| JetByteTools::IO::CSmartBuffer & | buffer, | |||
| DWORD | lastError | |||
| ) | [pure virtual] |
Called when an asynchronous read completes with an error.
Implemented in CDatagramSocketConnectionManagerCallback, CUDPConnectionCreator, and CDatagramSocketConnectionManagerCallback.
| virtual void OnWriteCompleted | ( | IDatagramSocket & | socket, | |
| JetByteTools::IO::CSmartBuffer & | buffer | |||
| ) | [pure virtual] |
Called when an asynchronous write completes. There's not a great deal that needs to be done here.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnWriteCompletionError | ( | IDatagramSocket & | socket, | |
| JetByteTools::IO::CSmartBuffer & | buffer, | |||
| DWORD | lastError | |||
| ) | [pure 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...
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnRecvFromCompleted | ( | IDatagramSocket & | socket, | |
| const IAddress & | address, | |||
| JetByteTools::IO::CSmartBuffer & | buffer | |||
| ) | [pure virtual] |
Called when an asynchronous recv from 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnRecvFromCompletionError | ( | IDatagramSocket & | socket, | |
| const IAddress & | address, | |||
| JetByteTools::IO::CSmartBuffer & | buffer, | |||
| DWORD | lastError | |||
| ) | [pure virtual] |
Called when an asynchronous recv from completes with an error.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnSendToCompleted | ( | IDatagramSocket & | socket, | |
| const IAddress & | address, | |||
| JetByteTools::IO::CSmartBuffer & | buffer | |||
| ) | [pure virtual] |
Called when an asynchronous send to completes. There's not a great deal that needs to be done here.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnSendToCompletionError | ( | IDatagramSocket & | socket, | |
| const IAddress & | address, | |||
| JetByteTools::IO::CSmartBuffer & | buffer, | |||
| DWORD | lastError | |||
| ) | [pure virtual] |
Called when an asynchronous send to completes with an error. In certain low resource situations you may find that the send to 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...
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnMaximumConnections | ( | ) | [pure 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnAllConnectionsAborted | ( | DWORD | numberOfConnectionsAborted | ) | [pure virtual] |
Called when connections have been aborted due to AbortAllConnections() being called either explicitly, or implicitly as part of a shutdown sequence.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnShutdownInitiated | ( | ) | [pure virtual] |
Called when the connection manager starts to shutdown.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnShutdownComplete | ( | ) | [pure virtual] |
Called when the connection manager has finished its shutdown process and all active connections have been released.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnConnectionReset | ( | IDatagramSocket & | socket, | |
| DWORD | lastError | |||
| ) | [pure virtual, inherited] |
Called when the connection is reset.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnConnectionClosure | ( | IDatagramSocket & | socket, | |
| ConnectionClosureReason | reason | |||
| ) | [pure virtual, inherited] |
Called when the connection is closed.
Implemented in CDatagramSocketConnectionManagerCallback, CUDPConnectionCreator, and CDatagramSocketConnectionManagerCallback.
| virtual void OnConnectionClosed | ( | IDatagramSocket & | socket | ) | [pure virtual, inherited] |
Called when the connection is closed. 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.
Implemented in CDatagramSocketConnectionManagerCallback, and CDatagramSocketConnectionManagerCallback.
| virtual void OnError | ( | const JetByteTools::Core::_tstring & | message | ) | [pure virtual, inherited] |
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?
Implemented in CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CDatagramSocketConnectionManagerCallback, CDatagramSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CDatagramSocketConnectionManagerCallback, CDatagramSocketServerCallback, and CStreamSocketServerExCallback.
| virtual void OnError | ( | const JetByteTools::Core::_tstring & | message, | |
| DWORD | lastError | |||
| ) | [pure virtual, inherited] |
Implemented in CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CDatagramSocketConnectionManagerCallback, CDatagramSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CDatagramSocketConnectionManagerCallback, CDatagramSocketServerCallback, and CStreamSocketServerExCallback.
