BALTECH SDK wrapper functions reference
monitor_protocol.h
Go to the documentation of this file.
1 
9 #ifndef __MONITOR_PROTOCOL_H__
10 #define __MONITOR_PROTOCOL_H__
11 
12 
13 #include "protocol.h"
14 
15 
16 #if !defined(BRP_LOG_DIR_PREFIX)
17  #define BRP_LOG_DIR_PREFIX "brp-logs/"
18 #endif
19 
20 
29 BRP_LIB brp_protocol brp_create_monitor(void);
30 
31 
39 BRP_LIB void brp_annotation_start(brp_protocol protocol);
40 
41 
54 BRP_LIB void brp_annotation_end(
55  brp_protocol protocol, bool success, char * comment
56 );
57 
58 
75 BRP_LIB brp_errcode brp_set_log_path(brp_protocol protocol, const char * path);
76 
77 
86 BRP_LIB char * brp_get_log_path(brp_protocol protocol, brp_mempool * mempool);
87 
88 
102 BRP_LIB brp_errcode brp_get_current_log_anchor(brp_protocol protocol, char ** anchor, brp_mempool * mempool);
103 
104 
105 #endif //__MONITOR_PROTOCOL_H__
106  // end of defgroup brp_lib
brp_errcode
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_annotation_end
BRP_LIB void brp_annotation_end(brp_protocol protocol, bool success, char *comment)
Marks the end of a related block of log entries and adds some kind of comment to it.
brp_get_current_log_anchor
BRP_LIB brp_errcode brp_get_current_log_anchor(brp_protocol protocol, char **anchor, brp_mempool *mempool)
Returns the anchor ID of the current (last written) log entry.
brp_annotation_start
BRP_LIB void brp_annotation_start(brp_protocol protocol)
Marks the beginning of a related block of log entries.
brp_protocol
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
protocol.h
This file primarly defines the common part of all protocol's data structures (:brp_protocol_t) and AP...
brp_set_log_path
BRP_LIB brp_errcode brp_set_log_path(brp_protocol protocol, const char *path)
Sets a custom log file path.
brp_mempool
struct brp_mempool_object_t * brp_mempool
mempool handle.
Definition: mempool.h:29
brp_get_log_path
BRP_LIB char * brp_get_log_path(brp_protocol protocol, brp_mempool *mempool)
Returns the current log file path.
brp_create_monitor
BRP_LIB brp_protocol brp_create_monitor(void)
Creates a new Monitor protocol layer.