IPacket Struct Reference

Base packet type. Data, Value, and Event packets are all also packets. Provides the packet's unique ID that is unique to a given device, as well as the packet type. More...

Inheritance diagram for IPacket:

Collaboration diagram for IPacket:

Detailed Description

Base packet type. Data, Value, and Event packets are all also packets. Provides the packet's unique ID that is unique to a given device, as well as the packet type.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getType (PacketType *type)=0
	Gets the packet's type. More...
virtual ErrCode INTERFACE_FUNC	subscribeForDestructNotification (IPacketDestructCallback *packetDestructCallback)=0
	Subscribes for notification when the packet is destroyed. More...
virtual ErrCode INTERFACE_FUNC	getRefCount (SizeT *refCount)=0
	Gets the reference count of the packet. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

getRefCount()

virtual ErrCode INTERFACE_FUNC getRefCount ( SizeT *  refCount )

pure virtual

Gets the reference count of the packet.

Parameters

[out]

refCount

The reference count of the packet.

getType()

virtual ErrCode INTERFACE_FUNC getType ( PacketType *  type )

pure virtual

Gets the packet's type.

Parameters

[out]

type

The packet type.

subscribeForDestructNotification()

virtual ErrCode INTERFACE_FUNC subscribeForDestructNotification ( IPacketDestructCallback *  packetDestructCallback )

pure virtual

Subscribes for notification when the packet is destroyed.

Parameters

packetDestructCallback

The callback that is called when the packet is destroyed.