Media Management System Library Functions mmsinit(3MS)
NAME
mmsinit, mmsainit, mmsgoodbye, mmsagoodbye, mmshello -
manage sessions between the client application and MS
SYNOPSIS
cc [ flag...] file... -lmms [ library...]
#include
int mmsinit(void *session, int *version);
int mmsainit(void *session, int *version,
void (*callbk)(void *arg));
int mmshello(void *session, char *host, char *app, char *ai,
char *tag, char *pass);
int mmsgoodbye(void *session, int force);
int mmsagoodbye(void *session, int force);
DESCRIPTION
The mmsinit() function creates and initializes the data
structure used by a client to communicate with the Media
Management System (MS) synchronously. The mmsainit() func-
tion creates and initializes the data structure used by a
client to communicate with MS asynchronously. On successful
completion, session contains the pointer to the data struc-
ture and version contains the MS 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 mmsinit() or mmsainit(). 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 mmshello() function establishes the session connection
between the client and MS. The client specifies the host
where M is running (host), application name (app),
SunOS 5.11 Last change: 28 Oct 2008 1
Media Management System Library Functions mmsinit(3MS)
application instance (ai), application tag (tag), and appli-
cation password (pass) to use to connect with MS. These
values must be present in MS for the connection to be
allowed.
The mmsgoodbye() function shuts down a synchronous session
between the client and MS.
The mmsagoodbye() function shuts down an asynchronous ses-
sion between the client and MS. If force is set, no goodbye
is sent to M.
RETURN VALUES
Upon successful completion, MSAPIOK is returned. If a
function has a processing error, it returns an error code
indicating the type of error.
ERORS
These functions will fail if:
MSAPIER Unrecoverable internal processing
error occurred.
MSAPINOTERSP Response is not an error response.
MSAPISHUTDOWN Client has shut down API.
MSASYNCAPIFAILURE Reader thread unable to obtain
reader mutex.
MSCFGFILER Unable to open watcher daemon's
network configuration file.
MSDUPLICATEREG Event is already registered.
MSECONECTER Failed to connect to MS.
MSEINVALIDRESPONSE Invalid MS response to command.
MSENETIOER Connection failure to MS.
SunOS 5.11 Last change: 28 Oct 2008 2
Media Management System Library Functions mmsinit(3MS)
MSESYNTAXER MS response contained a syntax
error.
MSERBIAS Unknown Error code.
MSEVREGFAILED MS did not accept event registra-
tion.
MSEVUNREGFAILED MS did not accept event unregis-
tration.
MSINVALIDRSP Unknown response type received.
MSMALOCEROR Unable to allocate required space.
MSMISINGTASKID Unable to find task ID in
response.
MSELECTEROR Select system call failed.
MSTRACEFAILURE Unable to open API's trace file.
MSWRONGAPIMODE API session does not support this
API command.
MSWRONGTASKID Wrong task ID found for accept
response.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 28 Oct 2008 3
Media Management System Library Functions mmsinit(3MS)
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Uncommitted
MT-Level MT-Safe
SEE ALSO
libmms(3LIB), mmsrsptype(3MS), mmssendcmd(3MS), attri-
butes(5)
SunOS 5.11 Last change: 28 Oct 2008 4
|