NAME

omlc_close - shutdown the OML client library

SYNOPSIS

#include <oml2/omlc.h>
int omlc_close(void);

DESCRIPTION

omlc_close() shuts down the OML client library, and stops all measurement processes. It also flushes all measurement streams to try to ensure that all measurements are stored correctly before the application terminates. The application should call omlc_close() if it intends to exit.

If omlc_inject(3) is called after omlc_close() has been called, then it will be ignored and not measurement collection will take place. Other API functions will return with an error.

RETURN VALUE

omlc_close() returns 0 on success; on error it returns -1.

ERRORS

omlc_close() will succeed unless the API has not already been initialized by a call to omlc_init(3).

BUGS

If a problem you are experiencing is not addressed in the FAQ (http://oml.mytestbed.net/projects/oml/wiki/FAQ_and_Support) nor already present in the list of know bugs (http://oml.mytestbed.net/projects/oml/issues). You could discuss it on the mailing list (details and archives at http://oml.mytestbed.net/tab/show?id=oml).

It is however advisable to open a ticket on our issue tracker at http://oml.mytestbed.net/projects/oml/issues/new. Don’t forget to include details such as client and server logs (at [--oml-log-level|-d] 2). It also helps if you can share the source code of a (minimal, if possible) example reliably triggering the problem.