CStreamSocketConnectionManagerCallback Class Reference
[Stream Sockets, Connection managers, Callback events, Null Objects]

Inheritance diagram for CStreamSocketConnectionManagerCallback:

[legend]

Collaboration diagram for CStreamSocketConnectionManagerCallback:

[legend]

List of all members.

---

Detailed Description

An object that implements the CStreamSocketConnectionManager callback interface and does nothing. You can derive from this class and override just the functions that you need to.

Public Member Functions
virtual void	OnSecureConnectionEstablished (JetByteTools::Socket::IStreamSocket &socket, const JetByteTools::Socket::IAddress &address)
	Called when a secure connection is established, i.e. a connection that is protected by SSL. This is called before the OnConnectionEstablished() is called and is intended to allow the user to do specific connection establishment operations that are only required for secure connections. The address is the address that the socket is connected to.
virtual void	OnSecureSocketReleased (JetByteTools::Win32::IIndexedOpaqueUserData &userData)
	Called when a secure connection is released back to the allocator. This is called after OnSocketReleased() and is intended to allow you to clean up any user data that you might need to clean up for secure connections.
virtual void	FatalError (JetByteTools::Socket::IStreamSocket &socket, const SECURITY_STATUS status)
	Called when there is a fatal error during security processing, such as a failure to negotiate or decrypt. The connection will be shutdown after this call completes.
virtual bool	Verify (JetByteTools::Socket::IStreamSocket &socket, const JetByteTools::Win32::_tstring &targetName, const JetByteTools::SChannel::CContext &context)
	Called to verify a connection's certificates.
virtual void	OnSocketCreated (SOCKET s) throw ()
	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	OnPreOutgoingConnect (JetByteTools::Win32::IIndexedOpaqueUserData &userData, const JetByteTools::Socket::IAddress &address, const void *pUserData) throw ()
	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.
virtual void	OnConnectionEstablished (JetByteTools::Socket::IStreamSocket &socket, const JetByteTools::Socket::IAddress &address)
	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 (JetByteTools::Socket::IStreamSocket &socket, const JetByteTools::Socket::IAddress &address, const DWORD lastError)
	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::Win32::IIndexedOpaqueUserData &userData)
	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.
virtual void	OnReadCompleted (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::IBuffer &buffer)
	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 (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::IBuffer &buffer, const DWORD lastError)
	Called when an asynchronous read completes with an error.
virtual void	OnWriteCompleted (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::IBuffer &buffer)
	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.
virtual void	OnWriteCompletionError (JetByteTools::Socket::IStreamSocket &socket, JetByteTools::IO::IBuffer &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...
virtual void	OnConnectionClientClose (JetByteTools::Socket::IStreamSocket &socket)
	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.
virtual void	OnConnectionReset (JetByteTools::Socket::IStreamSocket &socket, const DWORD lastError)
	Called when the connection is reset.
virtual void	OnConnectionClosed (JetByteTools::Socket::IStreamSocket &socket)
	Called when the connection is closed.
virtual void	OnMaximumConnections ()
	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	OnError (const JetByteTools::Win32::_tstring &message)
	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?

---

Member Function Documentation

void OnSecureConnectionEstablished	(	JetByteTools::Socket::IStreamSocket &	socket,
		const JetByteTools::Socket::IAddress &	address
	)			[virtual]

Called when a secure connection is established, i.e. a connection that is protected by SSL. This is called before the OnConnectionEstablished() is called and is intended to allow the user to do specific connection establishment operations that are only required for secure connections. The address is the address that the socket is connected to.

Implements ISecureStreamSocketCallback.

void OnSecureSocketReleased

(

JetByteTools::Win32::IIndexedOpaqueUserData &

userData

)

[virtual]

Called when a secure connection is released back to the allocator. This is called after OnSocketReleased() and is intended to allow you to clean up any user data that you might need to clean up for secure connections.

Implements ISecureStreamSocketCallback.

void FatalError	(	JetByteTools::Socket::IStreamSocket &	socket,
		const SECURITY_STATUS	status
	)			[virtual]

Called when there is a fatal error during security processing, such as a failure to negotiate or decrypt. The connection will be shutdown after this call completes.

Implements ISecureStreamSocketCallback.

virtual bool Verify	(	JetByteTools::Socket::IStreamSocket &	socket,
		const JetByteTools::Win32::_tstring &	targetName,
		const JetByteTools::SChannel::CContext &	context
	)			[virtual]

Called to verify a connection's certificates.

Implements ISecureStreamSocketCallback.

void OnSocketCreated

(

SOCKET

s

)

throw () [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::Win32::IIndexedOpaqueUserData &	userData,
		const JetByteTools::Socket::IAddress &	address,
		const void *	pUserData
	)			throw () [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
	)			[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,
		const DWORD	lastError
	)			[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::Win32::IIndexedOpaqueUserData &

userData

)

[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::IBuffer &	buffer
	)			[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.

virtual void OnReadCompletionError	(	JetByteTools::Socket::IStreamSocket &	socket,
		JetByteTools::IO::IBuffer &	buffer,
		const DWORD	lastError
	)			[virtual]

Called when an asynchronous read completes with an error.

Implements IStreamSocketConnectionManagerCallback.

void OnWriteCompleted	(	JetByteTools::Socket::IStreamSocket &	socket,
		JetByteTools::IO::IBuffer &	buffer
	)			[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.

virtual void OnWriteCompletionError	(	JetByteTools::Socket::IStreamSocket &	socket,
		JetByteTools::IO::IBuffer &	buffer,
		const DWORD	lastError
	)			[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 OnConnectionClientClose

(

JetByteTools::Socket::IStreamSocket &

socket

)

[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,
		const DWORD	lastError
	)			[virtual]

Called when the connection is reset.

Implements IStreamSocketCallback.

void OnConnectionClosed

(

JetByteTools::Socket::IStreamSocket &

socket

)

[virtual]

Called when the connection is closed.

Implements IStreamSocketCallback.

void OnMaximumConnections

(

)

[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.

virtual void OnError

(

const JetByteTools::Win32::_tstring &

message

)

[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.

---