IDatagramServerSocket Class Reference
[Sockets, Datagram Sockets, Interfaces, Protected destructors on abstract base classes]

Inheritance diagram for IDatagramServerSocket:

[legend]

Collaboration diagram for IDatagramServerSocket:

[legend]

List of all members.

---

Detailed Description

This interface provides an equivalent interface to the one provided by IAsyncSocket for IDatagramSocket and IStreamSocket. It does not feature the ability to issue Read() calls as the sockets derived from this interface are purely disconnected, datagram, server sockets; i.e. they're how you send a datagram back to whoever sent you the datagram that has just arrived. IDatagramSocket supports a pseudo connected interface where you can issue Read() calls ...

Public Types
typedef char	TimeToLive
typedef unsigned long	DataLength
typedef unsigned short	UserDataIndex
Public Member Functions
virtual void	Write (const char *pData, const DataLength dataLength)=0
virtual void	Write (const BYTE *pData, const DataLength dataLength)=0
virtual void	Write (JetByteTools::IO::IBuffer &buffer)=0
virtual bool	TryWrite (const char *pData, const DataLength dataLength)=0 throw ()
virtual bool	TryWrite (const BYTE *pData, const DataLength dataLength)=0 throw ()
virtual bool	TryWrite (JetByteTools::IO::IBuffer &buffer)=0 throw ()
virtual void	SendTo (const IAddress &address, const char *pData, const DataLength dataLength)=0
virtual void	SendTo (const IAddress &address, const BYTE *pData, const DataLength dataLength)=0
virtual void	SendTo (const IAddress &address, JetByteTools::IO::IBuffer &buffer)=0
virtual bool	TrySendTo (const IAddress &address, const char *pData, const DataLength dataLength)=0 throw ()
virtual bool	TrySendTo (const IAddress &address, const BYTE *pData, const DataLength dataLength)=0 throw ()
virtual bool	TrySendTo (const IAddress &address, JetByteTools::IO::IBuffer &buffer)=0 throw ()
virtual CAddress	GetLocalAddress () const =0
virtual CAddress	GetRemoteAddress () const =0
virtual void	AddRef ()=0
virtual void	Release ()=0
virtual void	Shutdown ()=0
virtual void	Shutdown (const ShutdownHow how)=0
virtual void	AbortConnection ()=0
virtual ConnectionDirection	GetConnectionDirection () const =0
virtual void	JoinMulticastGroup (const IAddress &groupAddress, const IAddress &interfaceAddress)=0
virtual void	BlockMulticastGroupSource (const IAddress &groupAddress, const IAddress &interfaceAddress, const IAddress &sourceAddress)=0
virtual void	UnblockMulticastGroupSource (const IAddress &groupAddress, const IAddress &interfaceAddress, const IAddress &sourceAddress)=0
virtual void	LeaveMulticastGroup (const IAddress &groupAddress, const IAddress &interfaceAddress)=0
virtual void	IncludeMulticastSource (const IAddress &groupAddress, const IAddress &interfaceAddress, const IAddress &sourceAddress)=0
virtual void	ExcludeMulticastSource (const IAddress &groupAddress, const IAddress &interfaceAddress, const IAddress &sourceAddress)=0
virtual void	SetMulticastSendInterface (const IAddress &interfaceAddress, const TimeToLive multicastTTL=1, const bool enableLoopback=false)=0
virtual void *	GetUserPointer (const UserDataIndex index) const =0
	Access the data stored at the specified index as a void pointer.
virtual void	SetUserPointer (const UserDataIndex index, void *pData)=0
	Update the data stored at the specified index as a void pointer.
virtual ULONG_PTR	GetUserData (const UserDataIndex index) const =0
	Access the data stored at the specified index as an unsigned long.
virtual void	SetUserData (const UserDataIndex index, const ULONG_PTR data)=0
	Update the data stored at the specified index as an unsigned long.
Protected Member Functions
	~IDatagramServerSocket ()
	We never delete instances of this interface; you must manage the lifetime of the class that implements it.

---

Member Typedef Documentation

typedef char TimeToLive [inherited]

typedef unsigned long DataLength [inherited]

typedef unsigned short UserDataIndex [inherited]

---

Constructor & Destructor Documentation

~IDatagramServerSocket

(

)

[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 Write	(	const char *	pData,
		const DataLength	dataLength
	)			[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void Write	(	const BYTE *	pData,
		const DataLength	dataLength
	)			[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void Write

(

JetByteTools::IO::IBuffer &

buffer

)

[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void SendTo	(	const IAddress &	address,
		const char *	pData,
		const DataLength	dataLength
	)			[pure virtual]

virtual void SendTo	(	const IAddress &	address,
		const BYTE *	pData,
		const DataLength	dataLength
	)			[pure virtual]

virtual void SendTo	(	const IAddress &	address,
		JetByteTools::IO::IBuffer &	buffer
	)			[pure virtual]

virtual CAddress GetLocalAddress

(

)

const [pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual CAddress GetRemoteAddress

(

)

const [pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void AddRef

(

)

[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void Release

(

)

[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void Shutdown

(

)

[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void Shutdown

(

const ShutdownHow

how

)

[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void AbortConnection

(

)

[pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual ConnectionDirection GetConnectionDirection

(

)

const [pure virtual]

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void JoinMulticastGroup	(	const IAddress &	groupAddress,
		const IAddress &	interfaceAddress
	)			[pure virtual, inherited]

Implemented in CDatagramSocketServer.

virtual void BlockMulticastGroupSource	(	const IAddress &	groupAddress,
		const IAddress &	interfaceAddress,
		const IAddress &	sourceAddress
	)			[pure virtual, inherited]

Implemented in CDatagramSocketServer.

virtual void UnblockMulticastGroupSource	(	const IAddress &	groupAddress,
		const IAddress &	interfaceAddress,
		const IAddress &	sourceAddress
	)			[pure virtual, inherited]

Implemented in CDatagramSocketServer.

virtual void LeaveMulticastGroup	(	const IAddress &	groupAddress,
		const IAddress &	interfaceAddress
	)			[pure virtual, inherited]

Implemented in CDatagramSocketServer.

virtual void IncludeMulticastSource	(	const IAddress &	groupAddress,
		const IAddress &	interfaceAddress,
		const IAddress &	sourceAddress
	)			[pure virtual, inherited]

Implemented in CDatagramSocketServer.

virtual void ExcludeMulticastSource	(	const IAddress &	groupAddress,
		const IAddress &	interfaceAddress,
		const IAddress &	sourceAddress
	)			[pure virtual, inherited]

Implemented in CDatagramSocketServer.

virtual void SetMulticastSendInterface	(	const IAddress &	interfaceAddress,
		const TimeToLive	multicastTTL = 1,
		const bool	enableLoopback = false
	)			[pure virtual, inherited]

virtual void* GetUserPointer

(

const UserDataIndex

index

)

const [pure virtual, inherited]

Access the data stored at the specified index as a void pointer.

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramSocket, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void SetUserPointer	(	const UserDataIndex	index,
		void *	pData
	)			[pure virtual, inherited]

Update the data stored at the specified index as a void pointer.

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramSocket, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual ULONG_PTR GetUserData

(

const UserDataIndex

index

)

const [pure virtual, inherited]

Access the data stored at the specified index as an unsigned long.

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramSocket, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

virtual void SetUserData	(	const UserDataIndex	index,
		const ULONG_PTR	data
	)			[pure virtual, inherited]

Update the data stored at the specified index as an unsigned long.

Implemented in TAsyncSocket< JetByteTools::Socket::IPoolableDatagramSocket, JetByteTools::Socket::IDatagramSocketConnectionManager, JetByteTools::Socket::IDatagramSocketCallback >, TAsyncSocket< JetByteTools::Socket::IPoolableStreamSocket, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketCallback >, and TAsyncSocket< JetByteTools::Socket::IPoolableDatagramServerSocket, JetByteTools::Socket::IDatagramServerSocketConnectionManager, JetByteTools::Socket::IDatagramServerSocketCallback >.

---