API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IBTOPPSERVER_ACCEPTPULLFROMPORT()

Brew Release
Brew MP 1.0.2
See Also
None
Description
Accepts PULL request from client. This serves the same purpose as IBTOPPServer_AcceptPull() for allowing object to be pulled by client, except it operates on IPort1 rather than byte array.
Params
_me
[in]:
the object
piPort1
[in]:
the source from which data can be read out and sent to OPP client; must not be NULL
uDataLen
[in]:
number of bytes of data available to be read
objName
[in]:
object name; must be valid
szType
[in]:
MIME type string
nReportFreq
[in]:
minimum number of bytes sent out between progress reports
Return
AEE_SUCCESS
[]:
The command has been scheduled, and PULL_RSP_PROGRESS and/or PULL_RSP_COMPLETE events will be generated.
AEE_EBADPARM
[]:
invalid input parameters
AEE_EBADSTATE
[]:
No pending PULL requests found.
Interface
Prototype
  •    AEEResult IBTOPPServer_AcceptPullFromPort (IBTOPPServer* _me,
                                                  IPort1* piPort1,
                                                  int uDataLen,
                                                  const _wchar_t* objName,
                                                  const char* szType,
                                                  int nReportFreq);
    
Side Effect
  • None
Comments
None