diff options
Diffstat (limited to 'include/dlt/dlt_client.h')
| -rw-r--r-- | include/dlt/dlt_client.h | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/include/dlt/dlt_client.h b/include/dlt/dlt_client.h index 6f62a67..a7ff7d4 100644 --- a/include/dlt/dlt_client.h +++ b/include/dlt/dlt_client.h @@ -98,31 +98,31 @@ void dlt_client_register_message_callback(int (*registerd_callback) (DltMessage * Initialising dlt client structure * @param client pointer to dlt client structure * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_init(DltClient *client, int verbose); +DltReturnValue dlt_client_init(DltClient *client, int verbose); /** * Connect to dlt daemon using the information from the dlt client structure * @param client pointer to dlt client structure * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_connect(DltClient *client, int verbose); +DltReturnValue dlt_client_connect(DltClient *client, int verbose); /** * Cleanup dlt client structure * @param client pointer to dlt client structure * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_cleanup(DltClient *client, int verbose); +DltReturnValue dlt_client_cleanup(DltClient *client, int verbose); /** * Main Loop of dlt client application * @param client pointer to dlt client structure * @param data pointer to data to be provided to the main loop * @param verbose if set to true verbose information is printed out. - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_main_loop(DltClient *client, void *data, int verbose); +DltReturnValue dlt_client_main_loop(DltClient *client, void *data, int verbose); /** * Send ancontrol message to the dlt daemon * @param client pointer to dlt client structure @@ -130,9 +130,9 @@ int dlt_client_main_loop(DltClient *client, void *data, int verbose); * @param ctid context id * @param payload Buffer filled with control message data * @param size Size of control message data - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_ctrl_msg(DltClient *client, char *apid, char *ctid, uint8_t *payload, uint32_t size); +DltReturnValue dlt_client_send_ctrl_msg(DltClient *client, char *apid, char *ctid, uint8_t *payload, uint32_t size); /** * Send an injection message to the dlt daemon * @param client pointer to dlt client structure @@ -141,68 +141,68 @@ int dlt_client_send_ctrl_msg(DltClient *client, char *apid, char *ctid, uint8_t * @param serviceID service id * @param buffer Buffer filled with injection message data * @param size Size of injection data within buffer - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_inject_msg(DltClient *client, char *apid, char *ctid, uint32_t serviceID, uint8_t *buffer, uint32_t size); +DltReturnValue dlt_client_send_inject_msg(DltClient *client, char *apid, char *ctid, uint32_t serviceID, uint8_t *buffer, uint32_t size); /** * Send an set log level message to the dlt daemon * @param client pointer to dlt client structure * @param apid application id * @param ctid context id * @param SendLogLevel Log Level - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_log_level(DltClient *client, char *apid, char *ctid, uint8_t logLevel); +DltReturnValue dlt_client_send_log_level(DltClient *client, char *apid, char *ctid, uint8_t logLevel); /** * Send a set trace status message to the dlt daemon * @param client pointer to dlt client structure * @param apid application id * @param ctid context id * @param defaultTraceStatus Default Trace Status - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_trace_status(DltClient *client, char *apid, char *ctid, uint8_t traceStatus); +DltReturnValue dlt_client_send_trace_status(DltClient *client, char *apid, char *ctid, uint8_t traceStatus); /** * Send the default log level to the dlt daemon * @param client pointer to dlt client structure * @param defaultLogLevel Default Log Level - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_default_log_level(DltClient *client, uint8_t defaultLogLevel); +DltReturnValue dlt_client_send_default_log_level(DltClient *client, uint8_t defaultLogLevel); /** * Send the default trace status to the dlt daemon * @param client pointer to dlt client structure * @param defaultTraceStatus Default Trace Status - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_default_trace_status(DltClient *client, uint8_t defaultTraceStatus); +DltReturnValue dlt_client_send_default_trace_status(DltClient *client, uint8_t defaultTraceStatus); /** * Send the timing pakets status to the dlt daemon * @param client pointer to dlt client structure * @param timingPakets Timing pakets enabled - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_timing_pakets(DltClient *client, uint8_t timingPakets); +DltReturnValue dlt_client_send_timing_pakets(DltClient *client, uint8_t timingPakets); /** * Send the store config command to the dlt daemon * @param client pointer to dlt client structure - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_store_config(DltClient *client); +DltReturnValue dlt_client_send_store_config(DltClient *client); /** * Send the reset to factory default command to the dlt daemon * @param client pointer to dlt client structure - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_send_reset_to_factory_default(DltClient *client); +DltReturnValue dlt_client_send_reset_to_factory_default(DltClient *client); /** * Set baudrate within dlt client structure * @param client pointer to dlt client structure * @param baudrate Baudrate - * @return negative value if there was an error + * @return Value from DltReturnValue enum */ -int dlt_client_setbaudrate(DltClient *client, int baudrate); +DltReturnValue dlt_client_setbaudrate(DltClient *client, int baudrate); #ifdef __cplusplus } |