IPktXPacketSink Interface Reference
[PacketX]

PacketSink class default interface. More...

List of all members.

Public Member Functions

HRESULT Advise ([in] IUnknown *pUnkCP)
 Register event sink.
HRESULT Unadvise (IUnknown *pUnkCP)
 Unregister event sink.
HRESULT CallBackOnPacket ([in] DWORD Handler,[in] DWORD Param)
 Register callback function.
HRESULT CallBackOnStatistics ([in] DWORD Handler,[in] DWORD Param)
 Register callback function.

Detailed Description

PacketSink class default interface.

This interface can be used to connect , register callback function handlers and disconnect from PacketX object.

Member Function Documentation

HRESULT IPktXPacketSink::Advise ( [in] IUnknown *  pUnkCP  ) 

Register event sink.

Connects event sink to event source object.

Parameters:
pUnkCP an interface pointer to the PacketX object.
Returns:
HRESULT error code.

HRESULT IPktXPacketSink::Unadvise ( IUnknown *  pUnkCP  ) 

Unregister event sink.

Disconnects event sink from event source object.

Parameters:
pUnkCP an interface pointer to the PacketX object.
Returns:
HRESULT error code.

HRESULT IPktXPacketSink::CallBackOnPacket ( [in] DWORD  Handler,
[in] DWORD  Param 
)

Register callback function.

Connects the callback function to _IPktXPacketXEvents::OnPacket event.

Parameters:
Handler the callback function pointer.
Param optional parameter passed to the callback function.
Returns:
HRESULT error code.
Note:
The callback function has the following prototype: 
 HRESULT FunctionName (IPktXPacket* pPacket, DWORD dwParam)
Example:
 // Callback function
 static HRESULT __Packet_Handler__(IPktXPacket* pPacket,DWORD dwParam){ retrun 0;}
 ...
 // Create sink
 IPktXPacketSinkPtr pSink;
 pSink.CreateInstance(__uuidof(PacketSink));
 ...
 // Set packet handler
 pSink->CallBackOnPacket((DWORD)__Packet_Handler__,(DWORD)0);

HRESULT IPktXPacketSink::CallBackOnStatistics ( [in] DWORD  Handler,
[in] DWORD  Param 
)

Register callback function.

Connects the callback function to _IPktXPacketXEvents::OnStatistics event.

Parameters:
Handler the callback function pointer.
Param optional parameter passed to the callback function.
Returns:
HRESULT error code.
Note:
The callback function has the following prototype: 
 HRESULT FunctionName (IPktXStatistics* pStats, DWORD dwParam)

The documentation for this interface was generated from the following file:
Copyright © 2000-2007 beeSync. All rights reserved.