Developer

API Reference

INETMGR_OnEvent()

Brew Release
Brew MP 1.0.2
Description
This function allows the caller to register to receive notification of in progress INetMgr operations. These include both network and socket functions.
This function also allows the caller to deregister from receiving the above notifications. When deregistering, if pfn is non-NULL, the callback associated with pfn and pUser is deregistered. If pfn is NULL, a callback associated with pUser is deregistered.
The user-specified callback should always be explicitly deregistered by the client; releasing the INetMgr object does not implicitly deregisters the callback.
Parameters
  • pINetMgr
    []:
    Pointer to the INetMgr Interface.
  • pfn
    []:
    User-specified callback to call when event occurs.
  • pUser
    []:
    User-specified context data passed as first argument to callback.
  • bRegister
    []:
    TRUE, if registering, FALSE if deregistering.
Interface
INETMGR
Prototype
    int INETMGR_OnEvent
    (
    INetMgr * pINetMgr,
    PFNNETMGREVENT pfn,
    void * pUser,
    boolean bRegister
    )
Return
SUCCESS: if registered ENOMEMORY: if allocation failure EALREADY: if a callback is already registered. If pfn is non-NULL, a callback associated with pfn and pUser is already registered. If pfn is NULL, a callback associated with pUser is already registered.
Other error codes are also possible
Side Effect
None.
Comment
None
  • Follow