Finished adding doxygen-style comments to document the app session
[OpenSRF.git] / include / opensrf / osrf_app_session.h
index b71f078..2ffcad0 100644 (file)
@@ -90,95 +90,57 @@ struct osrf_app_session_struct {
 };
 typedef struct osrf_app_session_struct osrfAppSession;
 
-
-
 // --------------------------------------------------------------------------
 // PUBLIC API ***
 // --------------------------------------------------------------------------
 
-/** Allocates a initializes a new app_session */
 osrfAppSession* osrfAppSessionClientInit( const char* remote_service );
 
-/** Allocates and initializes a new server session.  The global session cache
-       is checked to see if this session already exists, if so, it's returned
-*/
 osrfAppSession* osrf_app_server_session_init(
                const char* session_id, const char* our_app, const char* remote_id );
 
-/** sets the default locale for a session **/
 char* osrf_app_session_set_locale( osrfAppSession*, const char* );
 
-/** returns a session from the global session hash */
 osrfAppSession* osrf_app_session_find_session( const char* session_id );
 
-/** Builds a new app_request object with the given payload and returns
-       the id of the request.  This id is then used to perform work on the
-       request.  DEPRECATED; use osrfAppSessionSendRequest() instead.
-*/
+/* DEPRECATED; use osrfAppSessionSendRequest() instead. */
 int osrfAppSessionMakeRequest(
                osrfAppSession* session, const jsonObject* params,
                const char* method_name, int protocol, osrfStringArray* param_strings);
 
-/** Builds a new app_request object with the given payload and returns
-       the id of the request.  This id is then used to perform work on the
-       request.
-*/
 int osrfAppSessionSendRequest(
                 osrfAppSession* session, const jsonObject* params,
                 const char* method_name, int protocol );
 
-/** Sets the given request to complete state */
 void osrf_app_session_set_complete( osrfAppSession* session, int request_id );
 
-/** Returns true if the given request is complete */
 int osrf_app_session_request_complete( const osrfAppSession* session, int request_id );
 
-/** Does a recv call on the given request */
 osrfMessage* osrfAppSessionRequestRecv(
                osrfAppSession* session, int request_id, int timeout );
 
-/** Removes the request from the request set and frees the reqest */
 void osrf_app_session_request_finish( osrfAppSession* session, int request_id );
 
-/** Resends the orginal request with the given request id */
 int osrf_app_session_request_resend( osrfAppSession*, int request_id );
 
-/** Resets the remote connection target to that of the original*/
 void osrf_app_session_reset_remote( osrfAppSession* );
 
-/** Sets the remote target to 'remote_id' */
 void osrf_app_session_set_remote( osrfAppSession* session, const char* remote_id );
 
-/** pushes the given message into the result list of the app_request
-       whose request_id matches the messages thread_trace
-*/
-int osrf_app_session_push_queue( osrfAppSession*, osrfMessage* msg );
+void osrf_app_session_push_queue( osrfAppSession*, osrfMessage* msg );
 
-/** Attempts to connect to the remote service. Returns 1 on successful
-       connection, 0 otherwise.
-*/
 int osrfAppSessionConnect( osrfAppSession* );
 
-/** Sends a disconnect message to the remote service.  No response is expected */
 int osrf_app_session_disconnect( osrfAppSession* );
 
-/** Waits up to 'timeout' seconds for some data to arrive.
-       Any data that arrives will be processed according to its
-       payload and message type.  This method will return after
-       any data has arrived.
-*/
 int osrf_app_session_queue_wait( osrfAppSession*, int timeout, int* recvd );
 
-/** Disconnects (if client), frees any attached app_reuqests, removes the session from the
-       global session cache and frees the session.  Needless to say, only call this when the
-       session is completely done.
-*/
 void osrfAppSessionFree( osrfAppSession* );
 
-/** Tells the request to reset its wait timeout */
 void osrf_app_session_request_reset_timeout( osrfAppSession* session, int req_id );
 
 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, const jsonObject* data );
+
 int osrfAppRequestRespondComplete(
                osrfAppSession* ses, int requestId, const jsonObject* data );