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

• Home
• What
• Why
• How
• Who
• Products
• Pricing
• Blog
• Contact

Search

IIndexedOpaqueUserData Class Reference
[Interfaces, Opaque user data, Protected destructors on abstract base classes]

Inheritance diagram for IIndexedOpaqueUserData:

[legend]

Collaboration diagram for IIndexedOpaqueUserData:

[legend]

List of all members.

---

Detailed Description

Provides an interface that allows access to 'opaque user data' that is data that is stored as either a void * or an unsigned long and that is basically anything that the user wants to store. The data is stored by index and an implementation of this class is free to store the data in any way that it sees fit. An index represents a single storage location so a call to GetUserPointer() and GetUserData() on the same index will return the same data, just viewed in different ways.

Public Types
typedef unsigned short	UserDataIndex
Public Member Functions
virtual void *	GetUserPointer (UserDataIndex index) const =0
	Access the data stored at the specified index as a void pointer.
virtual void	SetUserPointer (UserDataIndex index, void *pData)=0
	Update the data stored at the specified index as a void pointer.
virtual ULONG_PTR	GetUserData (UserDataIndex index) const =0
	Access the data stored at the specified index as an unsigned long.
virtual void	SetUserData (UserDataIndex index, ULONG_PTR data)=0
	Update the data stored at the specified index as an unsigned long.
Static Public Attributes
static JETBYTE_CONSTEXPR UserDataIndex	InvalidUserDataIndex = 0xFFFF
Protected Member Functions
virtual	~IIndexedOpaqueUserData ()
	We never delete instances of this interface; you must manage the lifetime of the class that implements it.

---

Member Typedef Documentation

typedef unsigned short UserDataIndex

Reimplemented in TIndexedOpaqueUserData< JetByteTools::Core::IIndexedOpaqueUserData >, and TWebSocketBase< JetByteTools::WebSocket::HyBi::IWebSocket >.

---

Constructor & Destructor Documentation

virtual ~IIndexedOpaqueUserData

(

)

[protected, virtual]

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

---

Member Function Documentation

virtual void* GetUserPointer

(

UserDataIndex

index

)

const [pure virtual]

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

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

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

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

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

virtual ULONG_PTR GetUserData

(

UserDataIndex

index

)

const [pure virtual]

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

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

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

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

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

---

Member Data Documentation

JETBYTE_CONSTEXPR UserDataIndex InvalidUserDataIndex = 0xFFFF [static]

---