Developer

API Reference

IBTOPPServer_GetEvent()

Brew Release
Brew MP 1.0.2
See Also
IBTOPPServer_OnEventNotify
Description
Retrieves the next event from the event queue. Application should call this API repeatedly until it returns AEE_ENOMORE.
When receiving PULL_REQ or PUSH_REQ event whose objectInfo indicating a non-empty object name, application may call IBTOPPServer_GetObjectName() to retrieve the name. For PUSH_REQ, none-empty object type string could be retrieved via IBTOPPServer_GetObjectType().
Parameters
  • _me
    [in]:
    the object
  • pEvent
    [out]:
    destination for event data
    Return
  • AEE_SUCCESS
    []:
    event is successfully retrieved
  • AEE_EBADPARM
    []:
    invalid input parameters
  • AEE_ENOMORE
    []:
    no more events to retrieve
Interface
Prototype
   AEEResult IBTOPPServer_GetEvent (IBTOPPServer* _me, 
                                    AEEBTOPPSVREventType* pEvent);
Side Effect
None
Comment
None
  • Follow