obexbinding.h

SyncML手册及其编程

 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 */
Ret_t XPTAPI obpCloseCommunication( void *privateConnectionInfo );


/**
 * FUNCTION: Called when xptBeginExchange() is called
 *
 *  Prepare for a document exchange.
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 */
Ret_t XPTAPI obpBeginExchange(void *privateConnectionInfo);


/**
 * FUNCTION: Called when xptEndExchange() is called
 *
 *  Clean up after a document exchange.
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 */
Ret_t XPTAPI obpEndExchange(void *privateConnectionInfo);


/**
 * FUNCTION: Called when xptReceiveData() is called
 *
 *  Read data
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 *
 *     buffer, passed directly from the xptReceiveData() call.
 *
 *     bufferLen, passed directly from the xptReceiveData() call.
 *
 * OUT:
 *     dataLen, passed directly from the xptReceiveData() call.
 */
Ret_t XPTAPI obpReceiveData(void *privateConnectionInfo,
                            void *buffer,
                            size_t bufferLen,
                            size_t *dataLen);


/**
 * FUNCTION: Called when xptSendData() is called
 *
 *  Send data
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 *
 *     buffer, passed directly from the xptSendData() call.
 *
 *     bufferLen, passed directly from the xptSendData() call.
 *
 *     lastBlock, passed directly from the xptSendData() call.
 */
Ret_t XPTAPI obpSendData(void *privateConnectionInfo,
                         const void *buffer,
                         size_t bufferLen,
                         size_t *bytesSent);


/**
 * FUNCTION: Called when xptSendData() is called by the application, after
 *           sending the last byte of the document.
 *
 *  Complete send processing for an outgoing document.
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 *
 * NOTES:
 *
 *  The xpt interface layer counts the number of bytes the application
 *  writes using the xptSendData() function.  When the transport
 *  implementation has written the last byte of the document, the xpt
 *  interface layer calls this function in the transport implementation to
 *  allow it to perform any desired completion processing.  The length of
 *  the document is known because it was specified by the application in the
 *  xptSetDocumentInfo() call.
 *
 *  Any error returned from sendComplete() is returned to the application
 *  as the result value of the application's call to xptSendData().
 *
 *  Note that this function call does NOT correspond to an xptSendComplete()
 *  function call available to the application.  Instead, it is called
 *  automatically by the xpt interface layer when the application has
 *  successfully written the last byte of the document.
 */
Ret_t XPTAPI obpSendComplete(void *privateConnectionInfo);


/**
 * FUNCTION: Called when xptSetDocumentInfo() is called
 *
 *  Provide document information for an outgoing document.
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 *
 *     pDoc, passed directly from the xptSetDocumentInfo() call.
 */
Ret_t XPTAPI obpSetDocumentInfo( void *privateConnectionInfo,
                                 const XptCommunicationInfo_t *pDoc );


/**
 * FUNCTION: Called when xptGetDocumentInfo() is called
 *
 *  Retrieve the document information associated with an incoming document.
 *
 * IN: privateConnectionInfo, pointer to the transport binding's private
 *         information about the connection instance.  This is the same
 *         value that was returned by the "openCommunication" function when
 *         the connection instance was created.
 *
 *     pDoc, passed directly from the xptGetDocumentInfo() call.
 */
Ret_t XPTAPI obpGetDocumentInfo( void *privateConnectionInfo,
                                 XptCommunicationInfo_t *pDoc );


/*************************************************************************
 *                                                                       *
 * Functions dealing with protocol initialization                        *
 *                                                                       *
 *************************************************************************/

/**
 * FUNCTION: Called when initializeTransport() is called.
 *
 *  Setup xptTransportDescription information and call xptRegisterTransport().
 */
static Ret_t obpRegisterTransport( void );


/**
 * FUNCTION: Called to "deregister" the transport.
 */
static Ret_t obpDeregisterTransport( struct xptTransportDescription *xptBlock );


/*************************************************************************
 *                                                                       *
 * Functions that communicate to SyncBmr application                     *
 *                                                                       *
 *************************************************************************/

/**
 * FUNCTION: Called to send a document and wait for a response.
 */
static Ret_t obpSendRequest( void *privateConnectionInfo );


/**
 * FUNCTION: Called to send a document.
 */
static Ret_t obpSendResponse( void *privateConnectionInfo );


/**
 * FUNCTION: Called to receive an incoming document.
 */
static Ret_t obpReceiveResponse( void *privateConnectionInfo );


/*************************************************************************
 *                                                                       *
 * Internal Functions                                                    *
 *                                                                       *
 *************************************************************************/

/**
 * FUNCTION: Called to obtain a single document buffer.
 */
static Ret_t obpObtainBuffer( ObpBuffer *ob, size_t length );


/**
 * FUNCTION: Called to process outgoing request.
 */
static Ret_t obpProcessRequest( ObpConnectionBlock *ocb, SyncBmrRequest_t **reqP );


/**
 * FUNCTION: Called to process incoming response.
 */
static Ret_t obpProcessResponse( ObpConnectionBlock *ocb, SyncBmrResponse_t *respP );


#ifdef __cplusplus
}
#endif

#endif