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

Developer

API Reference

IOBEXSRVSESSION_AUTHENTICATE()

Brew Release
Brew MP 1.0.2
Description
This method will cause authentication to be initiated for the current request. The server may call this in response to a request from the client. Most often, the server would want to authenticate the client when it receives a connect request.Calling this method will cause the authentication challenge header to be sent to the client.
Params
po
[in]:
pointer to the object
charSet
[in]:
character set in which the realm string is encoded
pRealm
[in]:
pointer to realm information.
nRealmLen
[in]:
realm len
bUidReqd
[in]:
userID Reqd. TRUE if the server requires UserID from the client FALSE, if the server does not require UID from the client.
bFullAccess
[in]:
Type of Access TRUE, for full access FALSE, for readonly access.
Interface
Prototype
  •    int IOBEXSrvSession_Authenticate( IOBEXSrvSession       *po,
                                         AEEOBEXCharSet        charSet,
                                         uint8                 *pRealm,
                                         int                   nRealmLen,
                                         boolean               bUidReqd,
                                         boolean               bFullAccess);
    
Return
  • AEE_SUCCESS : the information was set. AEEOBEX_EVT_AUTH_COMPL is sent to the application to indicate the completion of authentication procedure AEE_EFAILED : No resources to store the information. AEE_EUNSUPPORTED : sent when the implementation does not support authentication for the current request.For e.g authentication may be supported only for the CONNECT request.
Side Effect
  • None.
Comments
AEEOBEX_EVT_AUTH_COMPL is sent when the authentication procedure is complete.