Go to the source code of this file.
Typedefs | |
| typedef void(* | logFd_DisconnectHandler_t) (void *) |
Functions | |
| void | logFd_ConnectService (void) |
| le_result_t | logFd_TryConnectService (void) |
| void | logFd_SetServerDisconnectHandler (logFd_DisconnectHandler_t disconnectHandler, void *contextPtr) |
| void | logFd_DisconnectService (void) |
| void | logFd_StdErr (int fd, const char *appName, const char *procName, int32_t pid) |
| void | logFd_StdOut (int fd, const char *appName, const char *procName, int32_t pid) |
Detailed Description
Legato File Descriptor Logging API include file.
Copyright (C) Sierra Wireless Inc.
Typedef Documentation
| typedef void(* logFd_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
Function Documentation
| void logFd_ConnectService | ( | void | ) |
Connect the current client thread to the service providing this API. Block until the service is available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.
This function is created automatically.
| void logFd_DisconnectService | ( | void | ) |
Disconnect the current client thread from the service providing this API.
Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.
This function is created automatically.
| void logFd_SetServerDisconnectHandler | ( | logFd_DisconnectHandler_t | disconnectHandler, |
| void * | contextPtr | ||
| ) |
Set handler called when server disconnection is detected.
When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.
| void logFd_StdErr | ( | int | fd, |
| const char * | appName, | ||
| const char * | procName, | ||
| int32_t | pid | ||
| ) |
Registers an application process' standard error for logging. Messages from this file descriptor will be logged at LE_LOG_ERR level.
- Returns
- LE_OK if successful. LE_FAULT if there was an error.
- Parameters
-
[in] fd stderr file descriptor. [in] appName Name of the application. [in] procName Name of the process. [in] pid PID of the process.
| void logFd_StdOut | ( | int | fd, |
| const char * | appName, | ||
| const char * | procName, | ||
| int32_t | pid | ||
| ) |
Registers an application process' standard out for logging. Messages from this file descriptor will be logged at LE_LOG_INFO level.
- Returns
- LE_OK if successful. LE_FAULT if there was an error.
- Parameters
-
[in] fd stdout file descriptor. [in] appName Name of the application. [in] procName Name of the process. [in] pid PID of the process.
| le_result_t logFd_TryConnectService | ( | void | ) |
Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.
This function is created automatically.
- Returns
- LE_OK if the client connected successfully to the service.
- LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
- LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
- LE_COMM_ERROR if the Service Directory cannot be reached.