mms_init(3MMS)					     Media Management System Library Functions					    mms_init(3MMS)

NAME

       mms_init, mms_ainit, mms_goodbye, mms_agoodbye, mms_hello - manage sessions between the client application and MMS

SYNOPSIS

       cc [ flag...] file... -lmms [ library...]
       #include <mms_api.h>

       int mms_init(void *session, int *version);

       int mms_ainit(void *session, int *version,
	    void (*callbk)(void *arg));

       int mms_hello(void *session, char *host, char *app, char *ai,
	    char *tag, char *pass);

       int mms_goodbye(void *session, int force);

       int mms_agoodbye(void *session, int force);

DESCRIPTION

       The  mms_init()	function creates and initializes the data structure used by a client to communicate with the Media Management System (MMS)
       synchronously. The mms_ainit() function creates and initializes the data structure used by a client to communicate with MMS asynchronously.
       On successful completion, session contains the pointer to the data structure and version contains the MMS API library version. If non-null,
       the callbk argument specifies which client routine to invoke if the asynchronous session shuts down.

       In the following functions, session is a session pointer returned by either mms_init() or mms_ainit(). The format of the  client's  logging
       routine is the following:

	 void logfunctionname(char *, char *)

       The first argument is the prefix and the second is the API error message of the error encountered.

       The  mms_hello()  function establishes the session connection between the client and MMS. The client specifies the host where MM is running
       (host), application name (app), application instance (ai), application tag (tag), and application password (pass) to use  to  connect  with
       MMS. These values must be present in MMS for the connection to be allowed.

       The mms_goodbye() function shuts down a synchronous session between the client and MMS.

       The mms_agoodbye() function shuts down an asynchronous session between the client and MMS. If force is set, no goodbye is sent to MM.

RETURN VALUES

       Upon  successful  completion, MMS_API_OK is returned. If a function has a processing error, it returns an error code indicating the type of
       error.

ERRORS

       These functions will fail if:

       MMS_API_ERR		 Unrecoverable internal processing error occurred.

       MMS_API_NOT_ERR_RSP	 Response is not an error response.

       MMS_API_SHUTDOWN 	 Client has shut down API.

       MMS_ASYNC_API_FAILURE	 Reader thread unable to obtain reader mutex.

       MMS_CFG_FILE_ERR 	 Unable to open watcher daemon's network configuration file.

       MMS_DUPLICATE_REG	 Event is already registered.

       MMS_E_CONNECT_ERR	 Failed to connect to MMS.

       MMS_E_INVALID_RESPONSE	 Invalid MMS response to command.

       MMS_E_NET_IO_ERR 	 Connection failure to MMS.

       MMS_E_SYNTAX_ERR 	 MMS response contained a syntax error.

       MMS_ERR_BIAS		 Unknown Error code.

       MMS_EV_REG_FAILED	 MMS did not accept event registration.

       MMS_EV_UNREG_FAILED	 MMS did not accept event unregistration.

       MMS_INVALID_RSP		 Unknown response type received.

       MMS_MALLOC_ERROR 	 Unable to allocate required space.

       MMS_MISSING_TASKID	 Unable to find task ID in response.

       MMS_SELECT_ERROR 	 Select system call failed.

       MMS_TRACE_FAILURE	 Unable to open API's trace file.

       MMS_WRONG_API_MODE	 API session does not support this API command.

       MMS_WRONG_TASKID 	 Wrong task ID found for accept response.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Uncommitted		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       libmms(3LIB), mms_rsp_type(3MMS), mms_send_cmd(3MMS), attributes(5)

SunOS 5.11							    28 Oct 2008 						    mms_init(3MMS)