Name | Synopsis | Description | Return Values | Errors | Attributes | See Also
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);
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.
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.
These functions will fail if:
Unrecoverable internal processing error occurred.
Response is not an error response.
Client has shut down API.
Reader thread unable to obtain reader mutex.
Unable to open watcher daemon's network configuration file.
Event is already registered.
Failed to connect to MMS.
Invalid MMS response to command.
Connection failure to MMS.
MMS response contained a syntax error.
Unknown Error code.
MMS did not accept event registration.
MMS did not accept event unregistration.
Unknown response type received.
Unable to allocate required space.
Unable to find task ID in response.
Select system call failed.
Unable to open API's trace file.
API session does not support this API command.
Wrong task ID found for accept response.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
---|---|
Interface Stability |
Uncommitted |
MT-Level |
MT-Safe |
Name | Synopsis | Description | Return Values | Errors | Attributes | See Also