IStreamSocketCallback Class Reference
[Sockets, Stream Sockets, Callback events, Interfaces, Protected destructors on abstract base classes]

Inheritance diagram for IStreamSocketCallback:

[legend]

Collaboration diagram for IStreamSocketCallback:

[legend]

List of all members.

---

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	OnConnectionClientClose (IStreamSocket &socket)=0
	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 (IStreamSocket &socket, const DWORD lastError)=0
	Called when the connection is reset.
virtual void	OnConnectionClosed (IStreamSocket &socket)=0
	Called when the connection is closed.
virtual void	OnError (const JetByteTools::Win32::_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?
Protected Member Functions
	~IStreamSocketCallback ()
	We never delete instances of this interface; you must manage the lifetime of the class that implements it.

---

Constructor & Destructor Documentation

~IStreamSocketCallback

(

)

[inline, protected]

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

---

Member Function Documentation

virtual void OnConnectionClientClose

(

IStreamSocket &

socket

)

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

Implemented in CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, and CStreamSocketServerExCallback.

virtual void OnConnectionReset	(	IStreamSocket &	socket,
		const DWORD	lastError
	)			[pure virtual]

Called when the connection is reset.

Implemented in CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, and CStreamSocketServerExCallback.

virtual void OnConnectionClosed

(

IStreamSocket &

socket

)

[pure virtual]

Called when the connection is closed.

Implemented in CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, and CStreamSocketServerExCallback.

virtual void OnError

(

const JetByteTools::Win32::_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, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CDatagramSocketConnectionManagerCallback, CDatagramSocketServerCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CStreamSocketServerExCallback, CStreamSocketConnectionManagerCallback, CStreamSocketServerCallback, CDatagramSocketConnectionManagerCallback, CDatagramSocketServerCallback, and CStreamSocketServerExCallback.

---