dnp3.h File Reference

#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	dnp3_logging_config_t
	Logging configuration options. More...
struct	dnp3_logger_t
	Logging interface that receives the log messages and writes them somewhere. More...
struct	dnp3_decode_level_t
	Controls the decoding of transmitted and received data at the application, transport, link, and physical layers. More...
struct	dnp3_runtime_config_t
	Runtime configuration. More...
struct	dnp3_control_field_t
	APDU Control field. More...
struct	dnp3_control_code_t
	CROB (dnp3_group12_var1_t) control code. More...
struct	dnp3_group12_var1_t
	Control Relay Output Block. More...
struct	dnp3_flags_t
	Collection of individual flag bits represented by an underlying mask value. More...
struct	dnp3_timestamp_t
	Timestamp value. More...
struct	dnp3_binary_input_t
	binary_input point More...
struct	dnp3_double_bit_binary_input_t
	double_bit_binary_input point More...
struct	dnp3_binary_output_status_t
	binary_output_status point More...
struct	dnp3_counter_t
	counter point More...
struct	dnp3_frozen_counter_t
	frozen_counter point More...
struct	dnp3_analog_input_t
	analog_input point More...
struct	dnp3_analog_output_status_t
	analog_output_status point More...
struct	dnp3_octet_string_t
	Octet String point. More...
struct	dnp3_port_state_listener_t
	Callback interface for receiving updates about the state of a serial port. More...
struct	dnp3_retry_strategy_t
	Retry strategy configuration. More...
struct	dnp3_serial_settings_t
	Serial port settings. More...
struct	dnp3_iin1_t
	First IIN byte. More...
struct	dnp3_iin2_t
	Second IIN byte. More...
struct	dnp3_iin_t
	Pair of IIN bytes. More...
struct	dnp3_response_header_t
	Response header information. More...
struct	dnp3_header_info_t
	Information about the object header and specific variation. More...
struct	dnp3_read_handler_t
	General handler that will receive all values read from the outstation. More...
struct	dnp3_master_channel_config_t
	Generic configuration for a MasterChannel. More...
struct	dnp3_client_state_listener_t
	Callback for monitoring the client TCP connection state. More...
struct	dnp3_tls_client_config_t
	TLS client configuration. More...
struct	dnp3_connect_strategy_t
	Timing parameters for connection attempts. More...
struct	dnp3_association_id_t
	Association identifier. More...
struct	dnp3_poll_id_t
	Poll identifier. More...
struct	dnp3_event_classes_t
	Event classes. More...
struct	dnp3_classes_t
	Class 0, 1, 2 and 3 config. More...
struct	dnp3_association_config_t
	Association configuration. More...
struct	dnp3_utc_timestamp_t
	Timestamp value returned by dnp3_association_handler_t::get_current_time. More...
struct	dnp3_association_handler_t
	Callbacks for a particular outstation association. More...
struct	dnp3_association_information_t
	Informational callbacks about the current state of an outstation association. More...
struct	dnp3_read_task_callback_t
	Handler for read tasks. More...
struct	dnp3_command_task_callback_t
	Handler for command tasks. More...
struct	dnp3_time_sync_task_callback_t
	Handler for time synchronization tasks. More...
struct	dnp3_restart_task_callback_t
	Handler for restart tasks. More...
struct	dnp3_link_status_callback_t
	Handler for link status check. More...
struct	dnp3_update_options_t
	Options that control how the update is performed. More...
struct	dnp3_binary_input_config_t
	Binary Input configuration. More...
struct	dnp3_double_bit_binary_input_config_t
	Double-Bit Binary Input configuration. More...
struct	dnp3_binary_output_status_config_t
	Binary Output Status configuration. More...
struct	dnp3_counter_config_t
	Counter configuration. More...
struct	dnp3_frozen_counter_config_t
	Frozen Counter configuration. More...
struct	dnp3_analog_input_config_t
	Analog configuration. More...
struct	dnp3_analog_output_status_config_t
	Analog Output Status configuration. More...
struct	dnp3_database_transaction_t
	Database transaction interface. More...
struct	dnp3_event_buffer_config_t
	Maximum number of events for each type. More...
struct	dnp3_class_zero_config_t
	Controls which types are reported during a Class 0 read. More...
struct	dnp3_outstation_features_t
	Optional outstation features that can be enabled or disabled. More...
struct	dnp3_outstation_config_t
	Outstation configuration. More...
struct	dnp3_restart_delay_t
	Restart delay used by dnp3_outstation_application_t::cold_restart and dnp3_outstation_application_t::warm_restart. More...
struct	dnp3_application_iin_t
	Application-controlled IIN bits. More...
struct	dnp3_outstation_application_t
	Dynamic information required by the outstation from the user application. More...
struct	dnp3_request_header_t
	Application-layer header for requests. More...
struct	dnp3_outstation_information_t
	Informational callbacks that the outstation doesn't rely on to function. More...
struct	dnp3_control_handler_t
	Callbacks for handling controls. More...
struct	dnp3_connection_state_listener_t
	Callback interface for connection state events. More...
struct	dnp3_tls_server_config_t
	TLS server configuration. More...

Macros
#define	DNP3_VERSION_MAJOR   1
#define	DNP3_VERSION_MINOR   1
#define	DNP3_VERSION_PATCH   0
#define	DNP3_VERSION_STRING   "1.1.0"
#define	DNP3_FLAG_ONLINE   0x01
	Object value is 'good' / 'valid' / 'nominal'. More...
#define	DNP3_FLAG_RESTART   0x02
	Object value has not been updated since device restart. More...
#define	DNP3_FLAG_COMM_LOST   0x04
	Object value represents the last value available before a communication failure occurred. Should never be set by originating devices. More...
#define	DNP3_FLAG_REMOTE_FORCED   0x08
	Object value is overridden in a downstream reporting device. More...
#define	DNP3_FLAG_LOCAL_FORCED   0x10
	Object value is overridden by the device reporting this flag. More...
#define	DNP3_FLAG_CHATTER_FILTER   0x20
	Object value is changing state rapidly (device dependent meaning) More...
#define	DNP3_FLAG_OVER_RANGE   0x20
	Object's true exceeds the measurement range of the reported variation. More...
#define	DNP3_FLAG_DISCONTINUITY   0x40
	Reported counter value cannot be compared against a prior value to obtain the correct count difference. More...
#define	DNP3_FLAG_REFERENCE_ERR   0x40
	Object's value might not have the expected level of accuracy. More...

Typedefs
typedef struct dnp3_runtime_t	dnp3_runtime_t
	Handle to the underlying runtime. More...
typedef struct dnp3_binary_input_iterator_t	dnp3_binary_input_iterator_t
	Iterator of binary_input. More...
typedef struct dnp3_double_bit_binary_input_iterator_t	dnp3_double_bit_binary_input_iterator_t
	Iterator of double_bit_binary_input. More...
typedef struct dnp3_binary_output_status_iterator_t	dnp3_binary_output_status_iterator_t
	Iterator of binary_output_status. More...
typedef struct dnp3_counter_iterator_t	dnp3_counter_iterator_t
	Iterator of counter. More...
typedef struct dnp3_frozen_counter_iterator_t	dnp3_frozen_counter_iterator_t
	Iterator of frozen_counter. More...
typedef struct dnp3_analog_input_iterator_t	dnp3_analog_input_iterator_t
	Iterator of analog_input. More...
typedef struct dnp3_analog_output_status_iterator_t	dnp3_analog_output_status_iterator_t
	Iterator of analog_output_status. More...
typedef struct dnp3_byte_iterator_t	dnp3_byte_iterator_t
	Iterator of uint8_t. More...
typedef struct dnp3_octet_string_iterator_t	dnp3_octet_string_iterator_t
	Iterator of octet_string. More...
typedef struct dnp3_endpoint_list_t	dnp3_endpoint_list_t
	List of IP endpoints. More...
typedef struct dnp3_master_channel_t	dnp3_master_channel_t
	Represents a communication channel for a master station. More...
typedef struct dnp3_request_t	dnp3_request_t
	Custom request. More...
typedef struct dnp3_command_set_t	dnp3_command_set_t
	Builder type used to construct command requests. More...
typedef struct dnp3_database_t	dnp3_database_t
	Internal database access. More...
typedef struct dnp3_octet_string_value_t	dnp3_octet_string_value_t
	Collection of octet_string_value. More...
typedef struct dnp3_database_handle_t	dnp3_database_handle_t
	handle used to perform transactions on the database More...
typedef struct dnp3_outstation_t	dnp3_outstation_t
	Outstation handle. More...
typedef struct dnp3_address_filter_t	dnp3_address_filter_t
	Outstation address filter. More...
typedef struct dnp3_outstation_server_t	dnp3_outstation_server_t
	TCP server that listens for connections and routes the messages to outstations. More...

Enumerations
enum	dnp3_param_error_t {   DNP3_PARAM_ERROR_OK = 0 , DNP3_PARAM_ERROR_INVALID_TIMEOUT = 1 , DNP3_PARAM_ERROR_NULL_PARAMETER = 2 , DNP3_PARAM_ERROR_NO_SUPPORT = 3 ,   DNP3_PARAM_ERROR_ASSOCIATION_DOES_NOT_EXIST = 4 , DNP3_PARAM_ERROR_ASSOCIATION_DUPLICATE_ADDRESS = 5 , DNP3_PARAM_ERROR_INVALID_SOCKET_ADDRESS = 6 , DNP3_PARAM_ERROR_INVALID_DNP3_ADDRESS = 7 ,   DNP3_PARAM_ERROR_INVALID_BUFFER_SIZE = 8 , DNP3_PARAM_ERROR_ADDRESS_FILTER_CONFLICT = 9 , DNP3_PARAM_ERROR_SERVER_ALREADY_STARTED = 10 , DNP3_PARAM_ERROR_SERVER_BIND_ERROR = 11 ,   DNP3_PARAM_ERROR_MASTER_ALREADY_SHUTDOWN = 12 , DNP3_PARAM_ERROR_RUNTIME_CREATION_FAILURE = 13 , DNP3_PARAM_ERROR_RUNTIME_DESTROYED = 14 , DNP3_PARAM_ERROR_RUNTIME_CANNOT_BLOCK_WITHIN_ASYNC = 15 ,   DNP3_PARAM_ERROR_LOGGING_ALREADY_CONFIGURED = 16 , DNP3_PARAM_ERROR_POINT_DOES_NOT_EXIST = 17 , DNP3_PARAM_ERROR_INVALID_PEER_CERTIFICATE = 18 , DNP3_PARAM_ERROR_INVALID_LOCAL_CERTIFICATE = 19 ,   DNP3_PARAM_ERROR_INVALID_PRIVATE_KEY = 20 , DNP3_PARAM_ERROR_INVALID_DNS_NAME = 21 , DNP3_PARAM_ERROR_OTHER_TLS_ERROR = 22 }
	Error type used throughout the library. More...
enum	dnp3_log_level_t {   DNP3_LOG_LEVEL_ERROR = 0 , DNP3_LOG_LEVEL_WARN = 1 , DNP3_LOG_LEVEL_INFO = 2 , DNP3_LOG_LEVEL_DEBUG = 3 ,   DNP3_LOG_LEVEL_TRACE = 4 }
	Log level. More...
enum	dnp3_log_output_format_t { DNP3_LOG_OUTPUT_FORMAT_TEXT = 0 , DNP3_LOG_OUTPUT_FORMAT_JSON = 1 }
	Describes how each log event is formatted. More...
enum	dnp3_time_format_t { DNP3_TIME_FORMAT_NONE = 0 , DNP3_TIME_FORMAT_RFC_3339 = 1 , DNP3_TIME_FORMAT_SYSTEM = 2 }
	Describes if and how the time will be formatted in log messages. More...
enum	dnp3_app_decode_level_t { DNP3_APP_DECODE_LEVEL_NOTHING = 0 , DNP3_APP_DECODE_LEVEL_HEADER = 1 , DNP3_APP_DECODE_LEVEL_OBJECT_HEADERS = 2 , DNP3_APP_DECODE_LEVEL_OBJECT_VALUES = 3 }
	Controls how transmitted and received application-layer fragments are decoded at the INFO log level. More...
enum	dnp3_transport_decode_level_t { DNP3_TRANSPORT_DECODE_LEVEL_NOTHING = 0 , DNP3_TRANSPORT_DECODE_LEVEL_HEADER = 1 , DNP3_TRANSPORT_DECODE_LEVEL_PAYLOAD = 2 }
	Controls how transmitted and received transport segments are decoded at the INFO log level. More...
enum	dnp3_link_decode_level_t { DNP3_LINK_DECODE_LEVEL_NOTHING = 0 , DNP3_LINK_DECODE_LEVEL_HEADER = 1 , DNP3_LINK_DECODE_LEVEL_PAYLOAD = 2 }
	Controls how transmitted and received link frames are decoded at the INFO log level. More...
enum	dnp3_phys_decode_level_t { DNP3_PHYS_DECODE_LEVEL_NOTHING = 0 , DNP3_PHYS_DECODE_LEVEL_LENGTH = 1 , DNP3_PHYS_DECODE_LEVEL_DATA = 2 }
	Controls how data transmitted at the physical layer (TCP, serial, etc) is logged. More...
enum	dnp3_trip_close_code_t { DNP3_TRIP_CLOSE_CODE_NUL = 0 , DNP3_TRIP_CLOSE_CODE_CLOSE = 1 , DNP3_TRIP_CLOSE_CODE_TRIP = 2 , DNP3_TRIP_CLOSE_CODE_RESERVED = 3 }
	Trip-Close Code field, used in conjunction with dnp3_op_type_t to specify a control operation. More...
enum	dnp3_op_type_t {   DNP3_OP_TYPE_NUL = 0 , DNP3_OP_TYPE_PULSE_ON = 1 , DNP3_OP_TYPE_PULSE_OFF = 2 , DNP3_OP_TYPE_LATCH_ON = 3 ,   DNP3_OP_TYPE_LATCH_OFF = 4 }
	Operation Type field, used in conjunction with dnp3_trip_close_code_t to specify a control operation. More...
enum	dnp3_time_quality_t { DNP3_TIME_QUALITY_SYNCHRONIZED_TIME = 0 , DNP3_TIME_QUALITY_UNSYNCHRONIZED_TIME = 1 , DNP3_TIME_QUALITY_INVALID_TIME = 2 }
	Timestamp quality. More...
enum	dnp3_double_bit_t { DNP3_DOUBLE_BIT_INTERMEDIATE = 0 , DNP3_DOUBLE_BIT_DETERMINED_OFF = 1 , DNP3_DOUBLE_BIT_DETERMINED_ON = 2 , DNP3_DOUBLE_BIT_INDETERMINATE = 3 }
	Double-bit binary input value. More...
enum	dnp3_port_state_t { DNP3_PORT_STATE_DISABLED = 0 , DNP3_PORT_STATE_WAIT = 1 , DNP3_PORT_STATE_OPEN = 2 , DNP3_PORT_STATE_SHUTDOWN = 3 }
	State of the serial port. More...
enum	dnp3_variation_t {   DNP3_VARIATION_GROUP1_VAR0 = 0 , DNP3_VARIATION_GROUP1_VAR1 = 1 , DNP3_VARIATION_GROUP1_VAR2 = 2 , DNP3_VARIATION_GROUP2_VAR0 = 3 ,   DNP3_VARIATION_GROUP2_VAR1 = 4 , DNP3_VARIATION_GROUP2_VAR2 = 5 , DNP3_VARIATION_GROUP2_VAR3 = 6 , DNP3_VARIATION_GROUP3_VAR0 = 7 ,   DNP3_VARIATION_GROUP3_VAR1 = 8 , DNP3_VARIATION_GROUP3_VAR2 = 9 , DNP3_VARIATION_GROUP4_VAR0 = 10 , DNP3_VARIATION_GROUP4_VAR1 = 11 ,   DNP3_VARIATION_GROUP4_VAR2 = 12 , DNP3_VARIATION_GROUP4_VAR3 = 13 , DNP3_VARIATION_GROUP10_VAR0 = 14 , DNP3_VARIATION_GROUP10_VAR1 = 15 ,   DNP3_VARIATION_GROUP10_VAR2 = 16 , DNP3_VARIATION_GROUP11_VAR0 = 17 , DNP3_VARIATION_GROUP11_VAR1 = 18 , DNP3_VARIATION_GROUP11_VAR2 = 19 ,   DNP3_VARIATION_GROUP12_VAR0 = 20 , DNP3_VARIATION_GROUP12_VAR1 = 21 , DNP3_VARIATION_GROUP20_VAR0 = 22 , DNP3_VARIATION_GROUP20_VAR1 = 23 ,   DNP3_VARIATION_GROUP20_VAR2 = 24 , DNP3_VARIATION_GROUP20_VAR5 = 25 , DNP3_VARIATION_GROUP20_VAR6 = 26 , DNP3_VARIATION_GROUP21_VAR0 = 27 ,   DNP3_VARIATION_GROUP21_VAR1 = 28 , DNP3_VARIATION_GROUP21_VAR2 = 29 , DNP3_VARIATION_GROUP21_VAR5 = 30 , DNP3_VARIATION_GROUP21_VAR6 = 31 ,   DNP3_VARIATION_GROUP21_VAR9 = 32 , DNP3_VARIATION_GROUP21_VAR10 = 33 , DNP3_VARIATION_GROUP22_VAR0 = 34 , DNP3_VARIATION_GROUP22_VAR1 = 35 ,   DNP3_VARIATION_GROUP22_VAR2 = 36 , DNP3_VARIATION_GROUP22_VAR5 = 37 , DNP3_VARIATION_GROUP22_VAR6 = 38 , DNP3_VARIATION_GROUP23_VAR0 = 39 ,   DNP3_VARIATION_GROUP23_VAR1 = 40 , DNP3_VARIATION_GROUP23_VAR2 = 41 , DNP3_VARIATION_GROUP23_VAR5 = 42 , DNP3_VARIATION_GROUP23_VAR6 = 43 ,   DNP3_VARIATION_GROUP30_VAR0 = 44 , DNP3_VARIATION_GROUP30_VAR1 = 45 , DNP3_VARIATION_GROUP30_VAR2 = 46 , DNP3_VARIATION_GROUP30_VAR3 = 47 ,   DNP3_VARIATION_GROUP30_VAR4 = 48 , DNP3_VARIATION_GROUP30_VAR5 = 49 , DNP3_VARIATION_GROUP30_VAR6 = 50 , DNP3_VARIATION_GROUP32_VAR0 = 51 ,   DNP3_VARIATION_GROUP32_VAR1 = 52 , DNP3_VARIATION_GROUP32_VAR2 = 53 , DNP3_VARIATION_GROUP32_VAR3 = 54 , DNP3_VARIATION_GROUP32_VAR4 = 55 ,   DNP3_VARIATION_GROUP32_VAR5 = 56 , DNP3_VARIATION_GROUP32_VAR6 = 57 , DNP3_VARIATION_GROUP32_VAR7 = 58 , DNP3_VARIATION_GROUP32_VAR8 = 59 ,   DNP3_VARIATION_GROUP40_VAR0 = 60 , DNP3_VARIATION_GROUP40_VAR1 = 61 , DNP3_VARIATION_GROUP40_VAR2 = 62 , DNP3_VARIATION_GROUP40_VAR3 = 63 ,   DNP3_VARIATION_GROUP40_VAR4 = 64 , DNP3_VARIATION_GROUP41_VAR0 = 65 , DNP3_VARIATION_GROUP41_VAR1 = 66 , DNP3_VARIATION_GROUP41_VAR2 = 67 ,   DNP3_VARIATION_GROUP41_VAR3 = 68 , DNP3_VARIATION_GROUP41_VAR4 = 69 , DNP3_VARIATION_GROUP42_VAR0 = 70 , DNP3_VARIATION_GROUP42_VAR1 = 71 ,   DNP3_VARIATION_GROUP42_VAR2 = 72 , DNP3_VARIATION_GROUP42_VAR3 = 73 , DNP3_VARIATION_GROUP42_VAR4 = 74 , DNP3_VARIATION_GROUP42_VAR5 = 75 ,   DNP3_VARIATION_GROUP42_VAR6 = 76 , DNP3_VARIATION_GROUP42_VAR7 = 77 , DNP3_VARIATION_GROUP42_VAR8 = 78 , DNP3_VARIATION_GROUP50_VAR1 = 79 ,   DNP3_VARIATION_GROUP50_VAR3 = 80 , DNP3_VARIATION_GROUP50_VAR4 = 81 , DNP3_VARIATION_GROUP51_VAR1 = 82 , DNP3_VARIATION_GROUP51_VAR2 = 83 ,   DNP3_VARIATION_GROUP52_VAR1 = 84 , DNP3_VARIATION_GROUP52_VAR2 = 85 , DNP3_VARIATION_GROUP60_VAR1 = 86 , DNP3_VARIATION_GROUP60_VAR2 = 87 ,   DNP3_VARIATION_GROUP60_VAR3 = 88 , DNP3_VARIATION_GROUP60_VAR4 = 89 , DNP3_VARIATION_GROUP80_VAR1 = 90 , DNP3_VARIATION_GROUP110 = 91 ,   DNP3_VARIATION_GROUP111 = 92 }
	Group/Variation. More...
enum	dnp3_data_bits_t { DNP3_DATA_BITS_FIVE = 0 , DNP3_DATA_BITS_SIX = 1 , DNP3_DATA_BITS_SEVEN = 2 , DNP3_DATA_BITS_EIGHT = 3 }
	Number of bits per character. More...
enum	dnp3_flow_control_t { DNP3_FLOW_CONTROL_NONE = 0 , DNP3_FLOW_CONTROL_SOFTWARE = 1 , DNP3_FLOW_CONTROL_HARDWARE = 2 }
	Flow control modes. More...
enum	dnp3_parity_t { DNP3_PARITY_NONE = 0 , DNP3_PARITY_ODD = 1 , DNP3_PARITY_EVEN = 2 }
	Parity checking modes. More...
enum	dnp3_stop_bits_t { DNP3_STOP_BITS_ONE = 0 , DNP3_STOP_BITS_TWO = 1 }
	Number of stop bits. More...
enum	dnp3_link_error_mode_t { DNP3_LINK_ERROR_MODE_DISCARD = 0 , DNP3_LINK_ERROR_MODE_CLOSE = 1 }
	Controls how errors in parsed link-layer frames are handled. This behavior is configurable for physical layers with built-in error correction like TCP as the connection might be through a terminal server. More...
enum	dnp3_min_tls_version_t { DNP3_MIN_TLS_VERSION_V12 = 0 , DNP3_MIN_TLS_VERSION_V13 = 1 }
	Minimum TLS version to allow. More...
enum	dnp3_certificate_mode_t { DNP3_CERTIFICATE_MODE_AUTHORITY_BASED = 0 , DNP3_CERTIFICATE_MODE_SELF_SIGNED = 1 }
	Determines how the certificate(s) presented by the peer are validated. More...
enum	dnp3_function_code_t {   DNP3_FUNCTION_CODE_CONFIRM = 0 , DNP3_FUNCTION_CODE_READ = 1 , DNP3_FUNCTION_CODE_WRITE = 2 , DNP3_FUNCTION_CODE_SELECT = 3 ,   DNP3_FUNCTION_CODE_OPERATE = 4 , DNP3_FUNCTION_CODE_DIRECT_OPERATE = 5 , DNP3_FUNCTION_CODE_DIRECT_OPERATE_NO_RESPONSE = 6 , DNP3_FUNCTION_CODE_IMMEDIATE_FREEZE = 7 ,   DNP3_FUNCTION_CODE_IMMEDIATE_FREEZE_NO_RESPONSE = 8 , DNP3_FUNCTION_CODE_FREEZE_CLEAR = 9 , DNP3_FUNCTION_CODE_FREEZE_CLEAR_NO_RESPONSE = 10 , DNP3_FUNCTION_CODE_FREEZE_AT_TIME = 11 ,   DNP3_FUNCTION_CODE_FREEZE_AT_TIME_NO_RESPONSE = 12 , DNP3_FUNCTION_CODE_COLD_RESTART = 13 , DNP3_FUNCTION_CODE_WARM_RESTART = 14 , DNP3_FUNCTION_CODE_INITIALIZE_DATA = 15 ,   DNP3_FUNCTION_CODE_INITIALIZE_APPLICATION = 16 , DNP3_FUNCTION_CODE_START_APPLICATION = 17 , DNP3_FUNCTION_CODE_STOP_APPLICATION = 18 , DNP3_FUNCTION_CODE_SAVE_CONFIGURATION = 19 ,   DNP3_FUNCTION_CODE_ENABLE_UNSOLICITED = 20 , DNP3_FUNCTION_CODE_DISABLE_UNSOLICITED = 21 , DNP3_FUNCTION_CODE_ASSIGN_CLASS = 22 , DNP3_FUNCTION_CODE_DELAY_MEASURE = 23 ,   DNP3_FUNCTION_CODE_RECORD_CURRENT_TIME = 24 , DNP3_FUNCTION_CODE_OPEN_FILE = 25 , DNP3_FUNCTION_CODE_CLOSE_FILE = 26 , DNP3_FUNCTION_CODE_DELETE_FILE = 27 ,   DNP3_FUNCTION_CODE_GET_FILE_INFO = 28 , DNP3_FUNCTION_CODE_AUTHENTICATE_FILE = 29 , DNP3_FUNCTION_CODE_ABORT_FILE = 30 , DNP3_FUNCTION_CODE_RESPONSE = 31 ,   DNP3_FUNCTION_CODE_UNSOLICITED_RESPONSE = 32 }
	Application layer function code. More...
enum	dnp3_response_function_t { DNP3_RESPONSE_FUNCTION_RESPONSE = 0 , DNP3_RESPONSE_FUNCTION_UNSOLICITED_RESPONSE = 1 }
	Type of response. More...
enum	dnp3_qualifier_code_t {   DNP3_QUALIFIER_CODE_RANGE8 = 0 , DNP3_QUALIFIER_CODE_RANGE16 = 1 , DNP3_QUALIFIER_CODE_ALL_OBJECTS = 2 , DNP3_QUALIFIER_CODE_COUNT8 = 3 ,   DNP3_QUALIFIER_CODE_COUNT16 = 4 , DNP3_QUALIFIER_CODE_COUNT_AND_PREFIX_8 = 5 , DNP3_QUALIFIER_CODE_COUNT_AND_PREFIX_16 = 6 , DNP3_QUALIFIER_CODE_FREE_FORMAT_16 = 7 }
	Qualifier code used in the response. More...
enum	dnp3_read_type_t { DNP3_READ_TYPE_STARTUP_INTEGRITY = 0 , DNP3_READ_TYPE_UNSOLICITED = 1 , DNP3_READ_TYPE_SINGLE_POLL = 2 , DNP3_READ_TYPE_PERIODIC_POLL = 3 }
	Describes the source of a read event. More...
enum	dnp3_client_state_t {   DNP3_CLIENT_STATE_DISABLED = 0 , DNP3_CLIENT_STATE_CONNECTING = 1 , DNP3_CLIENT_STATE_CONNECTED = 2 , DNP3_CLIENT_STATE_WAIT_AFTER_FAILED_CONNECT = 3 ,   DNP3_CLIENT_STATE_WAIT_AFTER_DISCONNECT = 4 , DNP3_CLIENT_STATE_SHUTDOWN = 5 }
	State of the client connection. More...
enum	dnp3_nothing_t { DNP3_NOTHING_NOTHING = 0 }
	A single value enum which is used as a placeholder for futures that don't return a value. More...
enum	dnp3_auto_time_sync_t { DNP3_AUTO_TIME_SYNC_NONE = 0 , DNP3_AUTO_TIME_SYNC_LAN = 1 , DNP3_AUTO_TIME_SYNC_NON_LAN = 2 }
	Automatic time synchronization configuration. More...
enum	dnp3_task_type_t {   DNP3_TASK_TYPE_USER_READ = 0 , DNP3_TASK_TYPE_PERIODIC_POLL = 1 , DNP3_TASK_TYPE_STARTUP_INTEGRITY = 2 , DNP3_TASK_TYPE_AUTO_EVENT_SCAN = 3 ,   DNP3_TASK_TYPE_COMMAND = 4 , DNP3_TASK_TYPE_CLEAR_RESTART_BIT = 5 , DNP3_TASK_TYPE_ENABLE_UNSOLICITED = 6 , DNP3_TASK_TYPE_DISABLE_UNSOLICITED = 7 ,   DNP3_TASK_TYPE_TIME_SYNC = 8 , DNP3_TASK_TYPE_RESTART = 9 }
	Task type used in dnp3_association_information_t. More...
enum	dnp3_task_error_t {   DNP3_TASK_ERROR_TOO_MANY_REQUESTS = 0 , DNP3_TASK_ERROR_BAD_RESPONSE = 1 , DNP3_TASK_ERROR_RESPONSE_TIMEOUT = 2 , DNP3_TASK_ERROR_WRITE_ERROR = 3 ,   DNP3_TASK_ERROR_NO_CONNECTION = 4 , DNP3_TASK_ERROR_SHUTDOWN = 5 , DNP3_TASK_ERROR_ASSOCIATION_REMOVED = 6 }
	Task error used in dnp3_association_information_t. More...
enum	dnp3_read_error_t {   DNP3_READ_ERROR_OK = 0 , DNP3_READ_ERROR_TOO_MANY_REQUESTS = 1 , DNP3_READ_ERROR_BAD_RESPONSE = 2 , DNP3_READ_ERROR_RESPONSE_TIMEOUT = 3 ,   DNP3_READ_ERROR_WRITE_ERROR = 4 , DNP3_READ_ERROR_NO_CONNECTION = 5 , DNP3_READ_ERROR_SHUTDOWN = 6 , DNP3_READ_ERROR_ASSOCIATION_REMOVED = 7 }
	Errors that can occur during a read operation. More...
enum	dnp3_command_mode_t { DNP3_COMMAND_MODE_DIRECT_OPERATE = 0 , DNP3_COMMAND_MODE_SELECT_BEFORE_OPERATE = 1 }
	Command operation mode. More...
enum	dnp3_command_error_t {   DNP3_COMMAND_ERROR_OK = 0 , DNP3_COMMAND_ERROR_BAD_STATUS = 1 , DNP3_COMMAND_ERROR_HEADER_MISMATCH = 2 , DNP3_COMMAND_ERROR_TOO_MANY_REQUESTS = 3 ,   DNP3_COMMAND_ERROR_BAD_RESPONSE = 4 , DNP3_COMMAND_ERROR_RESPONSE_TIMEOUT = 5 , DNP3_COMMAND_ERROR_WRITE_ERROR = 6 , DNP3_COMMAND_ERROR_NO_CONNECTION = 7 ,   DNP3_COMMAND_ERROR_SHUTDOWN = 8 , DNP3_COMMAND_ERROR_ASSOCIATION_REMOVED = 9 }
	Result of a command. More...
enum	dnp3_time_sync_mode_t { DNP3_TIME_SYNC_MODE_LAN = 0 , DNP3_TIME_SYNC_MODE_NON_LAN = 1 }
	Time synchronization mode. More...
enum	dnp3_time_sync_error_t {   DNP3_TIME_SYNC_ERROR_OK = 0 , DNP3_TIME_SYNC_ERROR_CLOCK_ROLLBACK = 1 , DNP3_TIME_SYNC_ERROR_SYSTEM_TIME_NOT_UNIX = 2 , DNP3_TIME_SYNC_ERROR_BAD_OUTSTATION_TIME_DELAY = 3 ,   DNP3_TIME_SYNC_ERROR_OVERFLOW = 4 , DNP3_TIME_SYNC_ERROR_STILL_NEEDS_TIME = 5 , DNP3_TIME_SYNC_ERROR_SYSTEM_TIME_NOT_AVAILABLE = 6 , DNP3_TIME_SYNC_ERROR_IIN_ERROR = 7 ,   DNP3_TIME_SYNC_ERROR_TOO_MANY_REQUESTS = 8 , DNP3_TIME_SYNC_ERROR_BAD_RESPONSE = 9 , DNP3_TIME_SYNC_ERROR_RESPONSE_TIMEOUT = 10 , DNP3_TIME_SYNC_ERROR_WRITE_ERROR = 11 ,   DNP3_TIME_SYNC_ERROR_NO_CONNECTION = 12 , DNP3_TIME_SYNC_ERROR_SHUTDOWN = 13 , DNP3_TIME_SYNC_ERROR_ASSOCIATION_REMOVED = 14 }
	Possible errors that can occur during a time synchronization procedure. More...
enum	dnp3_restart_error_t {   DNP3_RESTART_ERROR_OK = 0 , DNP3_RESTART_ERROR_TOO_MANY_REQUESTS = 1 , DNP3_RESTART_ERROR_BAD_RESPONSE = 2 , DNP3_RESTART_ERROR_RESPONSE_TIMEOUT = 3 ,   DNP3_RESTART_ERROR_WRITE_ERROR = 4 , DNP3_RESTART_ERROR_NO_CONNECTION = 5 , DNP3_RESTART_ERROR_SHUTDOWN = 6 , DNP3_RESTART_ERROR_ASSOCIATION_REMOVED = 7 }
	Errors that can occur during a cold/warm restart operation. More...
enum	dnp3_link_status_error_t {   DNP3_LINK_STATUS_ERROR_OK = 0 , DNP3_LINK_STATUS_ERROR_UNEXPECTED_RESPONSE = 1 , DNP3_LINK_STATUS_ERROR_TOO_MANY_REQUESTS = 2 , DNP3_LINK_STATUS_ERROR_BAD_RESPONSE = 3 ,   DNP3_LINK_STATUS_ERROR_RESPONSE_TIMEOUT = 4 , DNP3_LINK_STATUS_ERROR_WRITE_ERROR = 5 , DNP3_LINK_STATUS_ERROR_NO_CONNECTION = 6 , DNP3_LINK_STATUS_ERROR_SHUTDOWN = 7 ,   DNP3_LINK_STATUS_ERROR_ASSOCIATION_REMOVED = 8 }
	Errors that can occur during a manually initiated link status check. See dnp3_master_channel_check_link_status. More...
enum	dnp3_event_class_t { DNP3_EVENT_CLASS_NONE = 0 , DNP3_EVENT_CLASS_CLASS1 = 1 , DNP3_EVENT_CLASS_CLASS2 = 2 , DNP3_EVENT_CLASS_CLASS3 = 3 }
	Event class. More...
enum	dnp3_event_mode_t { DNP3_EVENT_MODE_DETECT = 0 , DNP3_EVENT_MODE_FORCE = 1 , DNP3_EVENT_MODE_SUPPRESS = 2 }
	Controls how events are processed when updating values in the database. More...
enum	dnp3_static_binary_input_variation_t { DNP3_STATIC_BINARY_INPUT_VARIATION_GROUP1_VAR1 = 0 , DNP3_STATIC_BINARY_INPUT_VARIATION_GROUP1_VAR2 = 1 }
	Static binary input variation. More...
enum	dnp3_event_binary_input_variation_t { DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR1 = 0 , DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR2 = 1 , DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR3 = 2 }
	Event binary input variation. More...
enum	dnp3_static_double_bit_binary_input_variation_t { DNP3_STATIC_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP3_VAR1 = 0 , DNP3_STATIC_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP3_VAR2 = 1 }
	Static double-bit binary input variation. More...
enum	dnp3_event_double_bit_binary_input_variation_t { DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR1 = 0 , DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR2 = 1 , DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR3 = 2 }
	Event double-bit binary input variation. More...
enum	dnp3_static_binary_output_status_variation_t { DNP3_STATIC_BINARY_OUTPUT_STATUS_VARIATION_GROUP10_VAR1 = 0 , DNP3_STATIC_BINARY_OUTPUT_STATUS_VARIATION_GROUP10_VAR2 = 1 }
	Static binary output status variation. More...
enum	dnp3_event_binary_output_status_variation_t { DNP3_EVENT_BINARY_OUTPUT_STATUS_VARIATION_GROUP11_VAR1 = 0 , DNP3_EVENT_BINARY_OUTPUT_STATUS_VARIATION_GROUP11_VAR2 = 1 }
	Event binary output status variation. More...
enum	dnp3_static_counter_variation_t { DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR1 = 0 , DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR2 = 1 , DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR5 = 2 , DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR6 = 3 }
	Static counter variation. More...
enum	dnp3_event_counter_variation_t { DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR1 = 0 , DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR2 = 1 , DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR5 = 2 , DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR6 = 3 }
	Event counter variation. More...
enum	dnp3_static_frozen_counter_variation_t {   DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR1 = 0 , DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR2 = 1 , DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR5 = 2 , DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR6 = 3 ,   DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR9 = 4 , DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR10 = 5 }
	Static frozen counter variation. More...
enum	dnp3_event_frozen_counter_variation_t { DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR1 = 0 , DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR2 = 1 , DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR5 = 2 , DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR6 = 3 }
	Event frozen counter variation. More...
enum	dnp3_static_analog_input_variation_t {   DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR1 = 0 , DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR2 = 1 , DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR3 = 2 , DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR4 = 3 ,   DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR5 = 4 , DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR6 = 5 }
	Static analog variation. More...
enum	dnp3_event_analog_input_variation_t {   DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR1 = 0 , DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR2 = 1 , DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR3 = 2 , DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR4 = 3 ,   DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR5 = 4 , DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR6 = 5 , DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR7 = 6 , DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR8 = 7 }
	Event analog variation. More...
enum	dnp3_static_analog_output_status_variation_t { DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR1 = 0 , DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR2 = 1 , DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR3 = 2 , DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR4 = 3 }
	Static analog output status variation. More...
enum	dnp3_event_analog_output_status_variation_t {   DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR1 = 0 , DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR2 = 1 , DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR3 = 2 , DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR4 = 3 ,   DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR5 = 4 , DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR6 = 5 , DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR7 = 6 , DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR8 = 7 }
	Event analog output status variation. More...
enum	dnp3_restart_delay_type_t { DNP3_RESTART_DELAY_TYPE_NOT_SUPPORTED = 0 , DNP3_RESTART_DELAY_TYPE_SECONDS = 1 , DNP3_RESTART_DELAY_TYPE_MILLI_SECONDS = 2 }
	Type of restart delay value. Used by dnp3_restart_delay_t. More...
enum	dnp3_write_time_result_t { DNP3_WRITE_TIME_RESULT_OK = 0 , DNP3_WRITE_TIME_RESULT_PARAMETER_ERROR = 1 , DNP3_WRITE_TIME_RESULT_NOT_SUPPORTED = 2 }
	Write time result used by dnp3_outstation_application_t::write_absolute_time. More...
enum	dnp3_freeze_type_t { DNP3_FREEZE_TYPE_IMMEDIATE_FREEZE = 0 , DNP3_FREEZE_TYPE_FREEZE_AND_CLEAR = 1 }
	Freeze operation type. More...
enum	dnp3_freeze_result_t { DNP3_FREEZE_RESULT_OK = 0 , DNP3_FREEZE_RESULT_PARAMETER_ERROR = 1 , DNP3_FREEZE_RESULT_NOT_SUPPORTED = 2 }
	Result of a freeze operation. More...
enum	dnp3_broadcast_action_t { DNP3_BROADCAST_ACTION_PROCESSED = 0 , DNP3_BROADCAST_ACTION_IGNORED_BY_CONFIGURATION = 1 , DNP3_BROADCAST_ACTION_BAD_OBJECT_HEADERS = 2 , DNP3_BROADCAST_ACTION_UNSUPPORTED_FUNCTION = 3 }
	Enumeration describing how the outstation processed a broadcast request. More...
enum	dnp3_command_status_t {   DNP3_COMMAND_STATUS_SUCCESS = 0 , DNP3_COMMAND_STATUS_TIMEOUT = 1 , DNP3_COMMAND_STATUS_NO_SELECT = 2 , DNP3_COMMAND_STATUS_FORMAT_ERROR = 3 ,   DNP3_COMMAND_STATUS_NOT_SUPPORTED = 4 , DNP3_COMMAND_STATUS_ALREADY_ACTIVE = 5 , DNP3_COMMAND_STATUS_HARDWARE_ERROR = 6 , DNP3_COMMAND_STATUS_LOCAL = 7 ,   DNP3_COMMAND_STATUS_TOO_MANY_OPS = 8 , DNP3_COMMAND_STATUS_NOT_AUTHORIZED = 9 , DNP3_COMMAND_STATUS_AUTOMATION_INHIBIT = 10 , DNP3_COMMAND_STATUS_PROCESSING_LIMITED = 11 ,   DNP3_COMMAND_STATUS_OUT_OF_RANGE = 12 , DNP3_COMMAND_STATUS_DOWNSTREAM_LOCAL = 13 , DNP3_COMMAND_STATUS_ALREADY_COMPLETE = 14 , DNP3_COMMAND_STATUS_BLOCKED = 15 ,   DNP3_COMMAND_STATUS_CANCELED = 16 , DNP3_COMMAND_STATUS_BLOCKED_OTHER_MASTER = 17 , DNP3_COMMAND_STATUS_DOWNSTREAM_FAIL = 18 , DNP3_COMMAND_STATUS_NON_PARTICIPATING = 19 ,   DNP3_COMMAND_STATUS_UNKNOWN = 20 }
	Enumeration received from an outstation in response to command request. More...
enum	dnp3_operate_type_t { DNP3_OPERATE_TYPE_SELECT_BEFORE_OPERATE = 0 , DNP3_OPERATE_TYPE_DIRECT_OPERATE = 1 , DNP3_OPERATE_TYPE_DIRECT_OPERATE_NO_ACK = 2 }
	Enumeration describing how the master requested the control operation. More...
enum	dnp3_connection_state_t { DNP3_CONNECTION_STATE_CONNECTED = 0 , DNP3_CONNECTION_STATE_DISCONNECTED = 1 }
	Outstation connection state for connection-oriented transports, e.g. TCP. More...

Functions
static const char *	dnp3_param_error_to_string (dnp3_param_error_t value)
	Converts the enum to a string. More...
static const char *	dnp3_log_level_to_string (dnp3_log_level_t value)
	Converts the enum to a string. More...
static const char *	dnp3_log_output_format_to_string (dnp3_log_output_format_t value)
	Converts the enum to a string. More...
static const char *	dnp3_time_format_to_string (dnp3_time_format_t value)
	Converts the enum to a string. More...
static dnp3_logging_config_t	dnp3_logging_config_init ()
	Initialize the configuration to default values. More...
static dnp3_logger_t	dnp3_logger_init (void(*on_message)(dnp3_log_level_t, const char *, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_configure_logging (dnp3_logging_config_t config, dnp3_logger_t logger)
	Set the callback that will receive all the log messages. More...
static const char *	dnp3_app_decode_level_to_string (dnp3_app_decode_level_t value)
	Converts the enum to a string. More...
static const char *	dnp3_transport_decode_level_to_string (dnp3_transport_decode_level_t value)
	Converts the enum to a string. More...
static const char *	dnp3_link_decode_level_to_string (dnp3_link_decode_level_t value)
	Converts the enum to a string. More...
static const char *	dnp3_phys_decode_level_to_string (dnp3_phys_decode_level_t value)
	Converts the enum to a string. More...
static dnp3_decode_level_t	dnp3_decode_level_init ()
	Initialize log levels to defaults. More...
static dnp3_decode_level_t	dnp3_decode_level_nothing ()
	Initialize log levels to nothing. More...
static dnp3_runtime_config_t	dnp3_runtime_config_init ()
	Initialize the configuration to default values. More...
dnp3_param_error_t	dnp3_runtime_create (dnp3_runtime_config_t config, dnp3_runtime_t **out)
	Creates a new runtime for running the protocol stack. More...
void	dnp3_runtime_destroy (dnp3_runtime_t *instance)
	Destroy a runtime. More...
static const char *	dnp3_trip_close_code_to_string (dnp3_trip_close_code_t value)
	Converts the enum to a string. More...
static const char *	dnp3_op_type_to_string (dnp3_op_type_t value)
	Converts the enum to a string. More...
static dnp3_control_code_t	dnp3_control_code_init (dnp3_trip_close_code_t tcc, bool clear, dnp3_op_type_t op_type)
	Initialize a dnp3_control_code_t instance. More...
static dnp3_control_code_t	dnp3_control_code_from_op_type (dnp3_op_type_t op_type)
	Initialize a dnp3_control_code_t instance from a dnp3_op_type_t. More...
static dnp3_control_code_t	dnp3_control_code_from_tcc_and_op_type (dnp3_trip_close_code_t tcc, dnp3_op_type_t op_type)
	Initialize a dnp3_control_code_t instance from a dnp3_trip_close_code_t and a dnp3_op_type_t. More...
static dnp3_group12_var1_t	dnp3_group12_var1_init (dnp3_control_code_t code, uint8_t count, uint32_t on_time, uint32_t off_time)
	Fully construct dnp3_group12_var1_t specifying the value of each field. More...
static dnp3_group12_var1_t	dnp3_group12_var1_from_code (dnp3_control_code_t code)
	Construct a dnp3_group12_var1_t from a dnp3_control_code_t. More...
static dnp3_flags_t	dnp3_flags_init (uint8_t value)
	Fully construct dnp3_flags_t specifying the value of each field. More...
static const char *	dnp3_time_quality_to_string (dnp3_time_quality_t value)
	Converts the enum to a string. More...
static dnp3_timestamp_t	dnp3_timestamp_invalid_timestamp ()
	Creates an invalid timestamp struct. More...
static dnp3_timestamp_t	dnp3_timestamp_synchronized_timestamp (uint64_t value)
	Creates a synchronized timestamp struct. More...
static dnp3_timestamp_t	dnp3_timestamp_unsynchronized_timestamp (uint64_t value)
	Creates an unsynchronized timestamp struct. More...
static const char *	dnp3_double_bit_to_string (dnp3_double_bit_t value)
	Converts the enum to a string. More...
static dnp3_binary_input_t	dnp3_binary_input_init (uint16_t index, bool value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_binary_input_t specifying the value of each field. More...
dnp3_binary_input_t *	dnp3_binary_input_iterator_next (dnp3_binary_input_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static dnp3_double_bit_binary_input_t	dnp3_double_bit_binary_input_init (uint16_t index, dnp3_double_bit_t value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_double_bit_binary_input_t specifying the value of each field. More...
dnp3_double_bit_binary_input_t *	dnp3_double_bit_binary_input_iterator_next (dnp3_double_bit_binary_input_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static dnp3_binary_output_status_t	dnp3_binary_output_status_init (uint16_t index, bool value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_binary_output_status_t specifying the value of each field. More...
dnp3_binary_output_status_t *	dnp3_binary_output_status_iterator_next (dnp3_binary_output_status_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static dnp3_counter_t	dnp3_counter_init (uint16_t index, uint32_t value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_counter_t specifying the value of each field. More...
dnp3_counter_t *	dnp3_counter_iterator_next (dnp3_counter_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static dnp3_frozen_counter_t	dnp3_frozen_counter_init (uint16_t index, uint32_t value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_frozen_counter_t specifying the value of each field. More...
dnp3_frozen_counter_t *	dnp3_frozen_counter_iterator_next (dnp3_frozen_counter_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static dnp3_analog_input_t	dnp3_analog_input_init (uint16_t index, double value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_analog_input_t specifying the value of each field. More...
dnp3_analog_input_t *	dnp3_analog_input_iterator_next (dnp3_analog_input_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static dnp3_analog_output_status_t	dnp3_analog_output_status_init (uint16_t index, double value, dnp3_flags_t flags, dnp3_timestamp_t time)
	Fully construct dnp3_analog_output_status_t specifying the value of each field. More...
dnp3_analog_output_status_t *	dnp3_analog_output_status_iterator_next (dnp3_analog_output_status_iterator_t *iter)
	returns a pointer to the next value or NULL More...
uint8_t *	dnp3_byte_iterator_next (dnp3_byte_iterator_t *iter)
	returns a pointer to the next value or NULL More...
dnp3_octet_string_t *	dnp3_octet_string_iterator_next (dnp3_octet_string_iterator_t *iter)
	returns a pointer to the next value or NULL More...
static const char *	dnp3_port_state_to_string (dnp3_port_state_t value)
	Converts the enum to a string. More...
static dnp3_port_state_listener_t	dnp3_port_state_listener_init (void(*on_change)(dnp3_port_state_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
static const char *	dnp3_variation_to_string (dnp3_variation_t value)
	Converts the enum to a string. More...
static dnp3_retry_strategy_t	dnp3_retry_strategy_init ()
	Initialize to defaults. More...
static const char *	dnp3_data_bits_to_string (dnp3_data_bits_t value)
	Converts the enum to a string. More...
static const char *	dnp3_flow_control_to_string (dnp3_flow_control_t value)
	Converts the enum to a string. More...
static const char *	dnp3_parity_to_string (dnp3_parity_t value)
	Converts the enum to a string. More...
static const char *	dnp3_stop_bits_to_string (dnp3_stop_bits_t value)
	Converts the enum to a string. More...
static dnp3_serial_settings_t	dnp3_serial_settings_init ()
	Initialize to default values. More...
static const char *	dnp3_link_error_mode_to_string (dnp3_link_error_mode_t value)
	Converts the enum to a string. More...
static const char *	dnp3_min_tls_version_to_string (dnp3_min_tls_version_t value)
	Converts the enum to a string. More...
static const char *	dnp3_certificate_mode_to_string (dnp3_certificate_mode_t value)
	Converts the enum to a string. More...
static const char *	dnp3_function_code_to_string (dnp3_function_code_t value)
	Converts the enum to a string. More...
static const char *	dnp3_response_function_to_string (dnp3_response_function_t value)
	Converts the enum to a string. More...
static const char *	dnp3_qualifier_code_to_string (dnp3_qualifier_code_t value)
	Converts the enum to a string. More...
static const char *	dnp3_read_type_to_string (dnp3_read_type_t value)
	Converts the enum to a string. More...
static dnp3_read_handler_t	dnp3_read_handler_init (void(*begin_fragment)(dnp3_read_type_t, dnp3_response_header_t, void *), void(*end_fragment)(dnp3_read_type_t, dnp3_response_header_t, void *), void(*handle_binary_input)(dnp3_header_info_t, dnp3_binary_input_iterator_t *, void *), void(*handle_double_bit_binary_input)(dnp3_header_info_t, dnp3_double_bit_binary_input_iterator_t *, void *), void(*handle_binary_output_status)(dnp3_header_info_t, dnp3_binary_output_status_iterator_t *, void *), void(*handle_counter)(dnp3_header_info_t, dnp3_counter_iterator_t *, void *), void(*handle_frozen_counter)(dnp3_header_info_t, dnp3_frozen_counter_iterator_t *, void *), void(*handle_analog_input)(dnp3_header_info_t, dnp3_analog_input_iterator_t *, void *), void(*handle_analog_output_status)(dnp3_header_info_t, dnp3_analog_output_status_iterator_t *, void *), void(*handle_octet_string)(dnp3_header_info_t, dnp3_octet_string_iterator_t *, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_endpoint_list_t *	dnp3_endpoint_list_create (const char *main_endpoint)
	Create a new list of IP endpoints. More...
void	dnp3_endpoint_list_destroy (dnp3_endpoint_list_t *instance)
	Destroy a previously allocated endpoint list. More...
void	dnp3_endpoint_list_add (dnp3_endpoint_list_t *instance, const char *endpoint)
	Add an IP endpoint to the list. More...
static dnp3_master_channel_config_t	dnp3_master_channel_config_init (uint16_t address)
	Initialize dnp3_master_channel_config_t to default values. More...
static const char *	dnp3_client_state_to_string (dnp3_client_state_t value)
	Converts the enum to a string. More...
static dnp3_client_state_listener_t	dnp3_client_state_listener_init (void(*on_change)(dnp3_client_state_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
static dnp3_tls_client_config_t	dnp3_tls_client_config_init (const char *dns_name, const char *peer_cert_path, const char *local_cert_path, const char *private_key_path, const char *password)
	construct the configuration with defaults More...
static dnp3_connect_strategy_t	dnp3_connect_strategy_init ()
	Initialize to default values. More...
static const char *	dnp3_nothing_to_string (dnp3_nothing_t value)
	Converts the enum to a string. More...
dnp3_param_error_t	dnp3_master_channel_create_tcp (dnp3_runtime_t *runtime, dnp3_link_error_mode_t link_error_mode, dnp3_master_channel_config_t config, dnp3_endpoint_list_t *endpoints, dnp3_connect_strategy_t connect_strategy, dnp3_client_state_listener_t listener, dnp3_master_channel_t **out)
	Create a master channel that connects to the specified TCP endpoint(s) More...
dnp3_param_error_t	dnp3_master_channel_create_serial (dnp3_runtime_t *runtime, dnp3_master_channel_config_t config, const char *path, dnp3_serial_settings_t serial_params, uint64_t open_retry_delay, dnp3_port_state_listener_t listener, dnp3_master_channel_t **out)
	Create a master channel on the specified serial port. More...
void	dnp3_master_channel_destroy (dnp3_master_channel_t *instance)
	Shutdown a dnp3_master_channel_t and release all resources. More...
dnp3_param_error_t	dnp3_master_channel_create_tls (dnp3_runtime_t *runtime, dnp3_link_error_mode_t link_error_mode, dnp3_master_channel_config_t config, dnp3_endpoint_list_t *endpoints, dnp3_connect_strategy_t connect_strategy, dnp3_client_state_listener_t listener, dnp3_tls_client_config_t tls_config, dnp3_master_channel_t **out)
	Create a master channel that connects to the specified TCP endpoint(s) and establish a TLS session with the remote. More...
dnp3_param_error_t	dnp3_master_channel_enable (dnp3_master_channel_t *instance)
	start communications More...
dnp3_param_error_t	dnp3_master_channel_disable (dnp3_master_channel_t *instance)
	stop communications More...
static dnp3_event_classes_t	dnp3_event_classes_init (bool class1, bool class2, bool class3)
	Fully construct dnp3_event_classes_t specifying the value of each field. More...
static dnp3_event_classes_t	dnp3_event_classes_all ()
	Initialize all classes to true. More...
static dnp3_event_classes_t	dnp3_event_classes_none ()
	Initialize all classes to false. More...
static dnp3_classes_t	dnp3_classes_init (bool class0, bool class1, bool class2, bool class3)
	Fully construct dnp3_classes_t specifying the value of each field. More...
static dnp3_classes_t	dnp3_classes_all ()
	Initialize all classes to true. More...
static dnp3_classes_t	dnp3_classes_none ()
	Initialize all classes to false. More...
static const char *	dnp3_auto_time_sync_to_string (dnp3_auto_time_sync_t value)
	Converts the enum to a string. More...
static dnp3_association_config_t	dnp3_association_config_init (dnp3_event_classes_t disable_unsol_classes, dnp3_event_classes_t enable_unsol_classes, dnp3_classes_t startup_integrity_classes, dnp3_event_classes_t event_scan_on_events_available)
	Initialize the configuration with the specified values. More...
static dnp3_utc_timestamp_t	dnp3_utc_timestamp_valid (uint64_t value)
	Construct a valid dnp3_utc_timestamp_t. More...
static dnp3_utc_timestamp_t	dnp3_utc_timestamp_invalid ()
	Construct an invalid dnp3_utc_timestamp_t. More...
static dnp3_association_handler_t	dnp3_association_handler_init (dnp3_utc_timestamp_t(*get_current_time)(void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
static const char *	dnp3_task_type_to_string (dnp3_task_type_t value)
	Converts the enum to a string. More...
static const char *	dnp3_task_error_to_string (dnp3_task_error_t value)
	Converts the enum to a string. More...
static dnp3_association_information_t	dnp3_association_information_init (void(*task_start)(dnp3_task_type_t, dnp3_function_code_t, uint8_t, void *), void(*task_success)(dnp3_task_type_t, dnp3_function_code_t, uint8_t, void *), void(*task_fail)(dnp3_task_type_t, dnp3_task_error_t, void *), void(*unsolicited_response)(bool, uint8_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_request_t *	dnp3_request_create ()
	Create a new request. More...
dnp3_request_t *	dnp3_request_new_class (bool class0, bool class1, bool class2, bool class3)
	Create a new request asking for classes. More...
dnp3_request_t *	dnp3_request_new_all_objects (dnp3_variation_t variation)
	Create a new request asking for all objects of a particular variation. More...
dnp3_request_t *	dnp3_request_new_one_byte_range (dnp3_variation_t variation, uint8_t start, uint8_t stop)
	Create a new request asking for range of objects (using 8-bit start/stop). More...
dnp3_request_t *	dnp3_request_new_two_byte_range (dnp3_variation_t variation, uint16_t start, uint16_t stop)
	Create a new request asking for range of objects (using 16-bit start/stop). More...
dnp3_request_t *	dnp3_request_new_one_byte_limited_count (dnp3_variation_t variation, uint8_t count)
	Create a new request asking for a limited count of objects (using 8-bit start/stop). More...
dnp3_request_t *	dnp3_request_new_two_byte_limited_count (dnp3_variation_t variation, uint16_t count)
	Create a new request asking for a limited count of objects (using 16-bit start/stop). More...
void	dnp3_request_destroy (dnp3_request_t *instance)
	Destroy a request created with dnp3_request_create or dnp3_request_class_request. More...
void	dnp3_request_add_one_byte_range_header (dnp3_request_t *instance, dnp3_variation_t variation, uint8_t start, uint8_t stop)
	Add a one-byte start/stop variation interrogation. More...
void	dnp3_request_add_two_byte_range_header (dnp3_request_t *instance, dnp3_variation_t variation, uint16_t start, uint16_t stop)
	Add a two-byte start/stop variation interrogation. More...
void	dnp3_request_add_all_objects_header (dnp3_request_t *instance, dnp3_variation_t variation)
	Add an all objects variation interrogation. More...
void	dnp3_request_add_one_byte_limited_count_header (dnp3_request_t *instance, dnp3_variation_t variation, uint8_t count)
	Add a one-byte limited count variation interrogation. More...
void	dnp3_request_add_two_byte_limited_count_header (dnp3_request_t *instance, dnp3_variation_t variation, uint16_t count)
	Add a two-byte limited count variation interrogation. More...
dnp3_param_error_t	dnp3_master_channel_add_association (dnp3_master_channel_t *instance, uint16_t address, dnp3_association_config_t config, dnp3_read_handler_t read_handler, dnp3_association_handler_t association_handler, dnp3_association_information_t association_information, dnp3_association_id_t *out)
	Add an association to the channel. More...
dnp3_param_error_t	dnp3_master_channel_remove_association (dnp3_master_channel_t *instance, dnp3_association_id_t id)
	Remove an association from the channel. More...
dnp3_param_error_t	dnp3_master_channel_add_poll (dnp3_master_channel_t *instance, dnp3_association_id_t id, dnp3_request_t *request, uint64_t period, dnp3_poll_id_t *out)
	Add a periodic poll to an association. More...
dnp3_param_error_t	dnp3_master_channel_remove_poll (dnp3_master_channel_t *instance, dnp3_poll_id_t poll_id)
	Add a periodic poll to an association. More...
dnp3_param_error_t	dnp3_master_channel_demand_poll (dnp3_master_channel_t *instance, dnp3_poll_id_t poll_id)
	Demand the immediate execution of a poll previously created with dnp3_master_channel_add_poll. More...
dnp3_param_error_t	dnp3_master_channel_set_decode_level (dnp3_master_channel_t *instance, dnp3_decode_level_t decode_level)
	Set the decoding level for the channel. More...
dnp3_param_error_t	dnp3_master_channel_get_decode_level (dnp3_master_channel_t *instance, dnp3_decode_level_t *out)
	Get the decoding level for the channel. More...
static const char *	dnp3_read_error_to_string (dnp3_read_error_t value)
	Converts the enum to a string. More...
static dnp3_read_task_callback_t	dnp3_read_task_callback_init (void(*on_complete)(dnp3_nothing_t, void *), void(*on_failure)(dnp3_read_error_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_master_channel_read (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_request_t *request, dnp3_read_task_callback_t callback)
	Perform a read on the association. More...
dnp3_param_error_t	dnp3_master_channel_read_with_handler (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_request_t *request, dnp3_read_handler_t handler, dnp3_read_task_callback_t callback)
	Perform a read on the association. More...
dnp3_command_set_t *	dnp3_command_set_create ()
	Create a new set of commands. More...
void	dnp3_command_set_destroy (dnp3_command_set_t *instance)
	Destroy a set of commands. More...
void	dnp3_command_set_finish_header (dnp3_command_set_t *instance)
	Finish any partially completed header. This allows for the construction of two headers with the same type and index. More...
void	dnp3_command_set_add_g12_v1_u8 (dnp3_command_set_t *instance, uint8_t idx, dnp3_group12_var1_t header)
	Add a CROB with 1-byte prefix index. More...
void	dnp3_command_set_add_g12_v1_u16 (dnp3_command_set_t *instance, uint16_t idx, dnp3_group12_var1_t header)
	Add a CROB with 2-byte prefix index. More...
void	dnp3_command_set_add_g41_v1_u8 (dnp3_command_set_t *instance, uint8_t idx, int32_t value)
	Add a Analog Output command (signed 32-bit integer) with 1-byte prefix index. More...
void	dnp3_command_set_add_g41_v1_u16 (dnp3_command_set_t *instance, uint16_t idx, int32_t value)
	Add a Analog Output command (signed 32-bit integer) with 2-byte prefix index. More...
void	dnp3_command_set_add_g41_v2_u8 (dnp3_command_set_t *instance, uint8_t idx, int16_t value)
	Add a Analog Output command (signed 16-bit integer) with 1-byte prefix index. More...
void	dnp3_command_set_add_g41_v2_u16 (dnp3_command_set_t *instance, uint16_t idx, int16_t value)
	Add a Analog Output command (signed 16-bit integer) with 2-byte prefix index. More...
void	dnp3_command_set_add_g41_v3_u8 (dnp3_command_set_t *instance, uint8_t idx, float value)
	Add a Analog Output command (single-precision float) with 1-byte prefix index. More...
void	dnp3_command_set_add_g41_v3_u16 (dnp3_command_set_t *instance, uint16_t idx, float value)
	Add a Analog Output command (single-precision float) with 2-byte prefix index. More...
void	dnp3_command_set_add_g41_v4_u8 (dnp3_command_set_t *instance, uint8_t idx, double value)
	Add a Analog Output command (double-precision float) with 1-byte prefix index. More...
void	dnp3_command_set_add_g41_v4_u16 (dnp3_command_set_t *instance, uint16_t idx, double value)
	Add a Analog Output command (double-precision float) with 2-byte prefix index. More...
static const char *	dnp3_command_mode_to_string (dnp3_command_mode_t value)
	Converts the enum to a string. More...
static const char *	dnp3_command_error_to_string (dnp3_command_error_t value)
	Converts the enum to a string. More...
static dnp3_command_task_callback_t	dnp3_command_task_callback_init (void(*on_complete)(dnp3_nothing_t, void *), void(*on_failure)(dnp3_command_error_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_master_channel_operate (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_command_mode_t mode, dnp3_command_set_t *command, dnp3_command_task_callback_t callback)
	Asynchronously perform a command operation on the association. More...
static const char *	dnp3_time_sync_mode_to_string (dnp3_time_sync_mode_t value)
	Converts the enum to a string. More...
static const char *	dnp3_time_sync_error_to_string (dnp3_time_sync_error_t value)
	Converts the enum to a string. More...
static dnp3_time_sync_task_callback_t	dnp3_time_sync_task_callback_init (void(*on_complete)(dnp3_nothing_t, void *), void(*on_failure)(dnp3_time_sync_error_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_master_channel_synchronize_time (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_time_sync_mode_t mode, dnp3_time_sync_task_callback_t callback)
	Asynchronously perform a time sync operation to the association. More...
static const char *	dnp3_restart_error_to_string (dnp3_restart_error_t value)
	Converts the enum to a string. More...
static dnp3_restart_task_callback_t	dnp3_restart_task_callback_init (void(*on_complete)(uint64_t, void *), void(*on_failure)(dnp3_restart_error_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_master_channel_cold_restart (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_restart_task_callback_t callback)
	Asynchronously perform a cold restart operation to the association. More...
dnp3_param_error_t	dnp3_master_channel_warm_restart (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_restart_task_callback_t callback)
	Asynchronously perform a warm restart operation to the association. More...
static const char *	dnp3_link_status_error_to_string (dnp3_link_status_error_t value)
	Converts the enum to a string. More...
static dnp3_link_status_callback_t	dnp3_link_status_callback_init (void(*on_complete)(dnp3_nothing_t, void *), void(*on_failure)(dnp3_link_status_error_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_master_channel_check_link_status (dnp3_master_channel_t *instance, dnp3_association_id_t association, dnp3_link_status_callback_t callback)
	Asynchronously perform a link status check. More...
static const char *	dnp3_event_class_to_string (dnp3_event_class_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_mode_to_string (dnp3_event_mode_t value)
	Converts the enum to a string. More...
static dnp3_update_options_t	dnp3_update_options_detect_event ()
	Default event detection mode. Updates the static value and automatically detects event. More...
static dnp3_update_options_t	dnp3_update_options_no_event ()
	Only update the static value. Usefull during initialization of the database. More...
static const char *	dnp3_static_binary_input_variation_to_string (dnp3_static_binary_input_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_binary_input_variation_to_string (dnp3_event_binary_input_variation_t value)
	Converts the enum to a string. More...
static dnp3_binary_input_config_t	dnp3_binary_input_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_binary_input (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_binary_input_config_t config)
	Add a new BinaryInput point. More...
bool	dnp3_database_remove_binary_input (dnp3_database_t *instance, uint16_t index)
	Remove a BinaryInput point. More...
bool	dnp3_database_update_binary_input (dnp3_database_t *instance, dnp3_binary_input_t value, dnp3_update_options_t options)
	Update a BinaryInput point. More...
dnp3_param_error_t	dnp3_database_get_binary_input (dnp3_database_t *instance, uint16_t index, dnp3_binary_input_t *out)
	Get a BinaryInput point. More...
static const char *	dnp3_static_double_bit_binary_input_variation_to_string (dnp3_static_double_bit_binary_input_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_double_bit_binary_input_variation_to_string (dnp3_event_double_bit_binary_input_variation_t value)
	Converts the enum to a string. More...
static dnp3_double_bit_binary_input_config_t	dnp3_double_bit_binary_input_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_double_bit_binary_input (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_double_bit_binary_input_config_t config)
	Add a new Double-Bit Binary Input point. More...
bool	dnp3_database_remove_double_bit_binary_input (dnp3_database_t *instance, uint16_t index)
	Remove a Double-Bit Binary Input point. More...
bool	dnp3_database_update_double_bit_binary_input (dnp3_database_t *instance, dnp3_double_bit_binary_input_t value, dnp3_update_options_t options)
	Update a Double-Bit Binary Input point. More...
dnp3_param_error_t	dnp3_database_get_double_bit_binary_input (dnp3_database_t *instance, uint16_t index, dnp3_double_bit_binary_input_t *out)
	Get a Double-Bit Binary Input point. More...
static const char *	dnp3_static_binary_output_status_variation_to_string (dnp3_static_binary_output_status_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_binary_output_status_variation_to_string (dnp3_event_binary_output_status_variation_t value)
	Converts the enum to a string. More...
static dnp3_binary_output_status_config_t	dnp3_binary_output_status_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_binary_output_status (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_binary_output_status_config_t config)
	Add a new Binary Output Status point. More...
bool	dnp3_database_remove_binary_output_status (dnp3_database_t *instance, uint16_t index)
	Remove a Binary Output Status point. More...
bool	dnp3_database_update_binary_output_status (dnp3_database_t *instance, dnp3_binary_output_status_t value, dnp3_update_options_t options)
	Update a Binary Output Status point. More...
dnp3_param_error_t	dnp3_database_get_binary_output_status (dnp3_database_t *instance, uint16_t index, dnp3_binary_output_status_t *out)
	Get a Binary Output Status point. More...
static const char *	dnp3_static_counter_variation_to_string (dnp3_static_counter_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_counter_variation_to_string (dnp3_event_counter_variation_t value)
	Converts the enum to a string. More...
static dnp3_counter_config_t	dnp3_counter_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_counter (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_counter_config_t config)
	Add a new Counter point. More...
bool	dnp3_database_remove_counter (dnp3_database_t *instance, uint16_t index)
	Remove a Counter point. More...
bool	dnp3_database_update_counter (dnp3_database_t *instance, dnp3_counter_t value, dnp3_update_options_t options)
	Update a Counter point. More...
dnp3_param_error_t	dnp3_database_get_counter (dnp3_database_t *instance, uint16_t index, dnp3_counter_t *out)
	Get a Counter point. More...
static const char *	dnp3_static_frozen_counter_variation_to_string (dnp3_static_frozen_counter_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_frozen_counter_variation_to_string (dnp3_event_frozen_counter_variation_t value)
	Converts the enum to a string. More...
static dnp3_frozen_counter_config_t	dnp3_frozen_counter_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_frozen_counter (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_frozen_counter_config_t config)
	Add a new Frozen Counter point. More...
bool	dnp3_database_remove_frozen_counter (dnp3_database_t *instance, uint16_t index)
	Remove a Frozen Counter point. More...
bool	dnp3_database_update_frozen_counter (dnp3_database_t *instance, dnp3_frozen_counter_t value, dnp3_update_options_t options)
	Update an Frozen Counter point. More...
dnp3_param_error_t	dnp3_database_get_frozen_counter (dnp3_database_t *instance, uint16_t index, dnp3_frozen_counter_t *out)
	Get a Frozen Counter point. More...
static const char *	dnp3_static_analog_input_variation_to_string (dnp3_static_analog_input_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_analog_input_variation_to_string (dnp3_event_analog_input_variation_t value)
	Converts the enum to a string. More...
static dnp3_analog_input_config_t	dnp3_analog_input_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_analog_input (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_analog_input_config_t config)
	Add a new AnalogInput point. More...
bool	dnp3_database_remove_analog_input (dnp3_database_t *instance, uint16_t index)
	Remove an AnalogInput point. More...
bool	dnp3_database_update_analog_input (dnp3_database_t *instance, dnp3_analog_input_t value, dnp3_update_options_t options)
	Update a AnalogInput point. More...
dnp3_param_error_t	dnp3_database_get_analog_input (dnp3_database_t *instance, uint16_t index, dnp3_analog_input_t *out)
	Get a AnalogInput point. More...
static const char *	dnp3_static_analog_output_status_variation_to_string (dnp3_static_analog_output_status_variation_t value)
	Converts the enum to a string. More...
static const char *	dnp3_event_analog_output_status_variation_to_string (dnp3_event_analog_output_status_variation_t value)
	Converts the enum to a string. More...
static dnp3_analog_output_status_config_t	dnp3_analog_output_status_config_init ()
	Initialize to defaults. More...
bool	dnp3_database_add_analog_output_status (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class, dnp3_analog_output_status_config_t config)
	Add a new Analog Output Status point. More...
bool	dnp3_database_remove_analog_output_status (dnp3_database_t *instance, uint16_t index)
	Remove an Analog Output Status point. More...
bool	dnp3_database_update_analog_output_status (dnp3_database_t *instance, dnp3_analog_output_status_t value, dnp3_update_options_t options)
	Update a Analog Output Status point. More...
dnp3_param_error_t	dnp3_database_get_analog_output_status (dnp3_database_t *instance, uint16_t index, dnp3_analog_output_status_t *out)
	Get a Analog Output Status point. More...
dnp3_octet_string_value_t *	dnp3_octet_string_value_create ()
	Creates an instance of the collection. More...
void	dnp3_octet_string_value_destroy (dnp3_octet_string_value_t *instance)
	Destroys an instance of the collection. More...
void	dnp3_octet_string_value_add (dnp3_octet_string_value_t *instance, uint8_t value)
	Add a value to the collection. More...
bool	dnp3_database_add_octet_string (dnp3_database_t *instance, uint16_t index, dnp3_event_class_t point_class)
	Add a new Octet String point. More...
bool	dnp3_database_remove_octet_string (dnp3_database_t *instance, uint16_t index)
	Remove an Octet String point. More...
bool	dnp3_database_update_octet_string (dnp3_database_t *instance, uint16_t index, dnp3_octet_string_value_t *value, dnp3_update_options_t options)
	Update an Octet String point. More...
static dnp3_database_transaction_t	dnp3_database_transaction_init (void(*execute)(dnp3_database_t *, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
void	dnp3_database_handle_transaction (dnp3_database_handle_t *instance, dnp3_database_transaction_t callback)
	Acquire a mutex on the underlying database and apply a set of changes as a transaction. More...
static dnp3_event_buffer_config_t	dnp3_event_buffer_config_init (uint16_t max_binary, uint16_t max_double_bit_binary, uint16_t max_binary_output_status, uint16_t max_counter, uint16_t max_frozen_counter, uint16_t max_analog, uint16_t max_analog_output_status, uint16_t max_octet_string)
	Fully construct dnp3_event_buffer_config_t specifying the value of each field. More...
static dnp3_event_buffer_config_t	dnp3_event_buffer_config_no_events ()
	Create a configuration where no events are buffered. More...
static dnp3_class_zero_config_t	dnp3_class_zero_config_init ()
	Initialize to default values. More...
static dnp3_outstation_features_t	dnp3_outstation_features_init ()
	Initialize to default values. More...
static dnp3_outstation_config_t	dnp3_outstation_config_init (uint16_t outstation_address, uint16_t master_address, dnp3_event_buffer_config_t event_buffer_config)
	Initialize to defaults. More...
static const char *	dnp3_restart_delay_type_to_string (dnp3_restart_delay_type_t value)
	Converts the enum to a string. More...
static dnp3_restart_delay_t	dnp3_restart_delay_not_supported ()
	RestartDelay indicating that the request is not supported. More...
static dnp3_restart_delay_t	dnp3_restart_delay_seconds (uint16_t value)
	RestartDelay with a count of seconds. More...
static dnp3_restart_delay_t	dnp3_restart_delay_milliseconds (uint16_t value)
	RestartDelay with a count of milliseconds. More...
static const char *	dnp3_write_time_result_to_string (dnp3_write_time_result_t value)
	Converts the enum to a string. More...
static const char *	dnp3_freeze_type_to_string (dnp3_freeze_type_t value)
	Converts the enum to a string. More...
static const char *	dnp3_freeze_result_to_string (dnp3_freeze_result_t value)
	Converts the enum to a string. More...
static dnp3_application_iin_t	dnp3_application_iin_init ()
	Initialize all fields in dnp3_application_iin_t to false. More...
static dnp3_outstation_application_t	dnp3_outstation_application_init (uint16_t(*get_processing_delay_ms)(void *), dnp3_write_time_result_t(*write_absolute_time)(uint64_t, void *), dnp3_application_iin_t(*get_application_iin)(void *), dnp3_restart_delay_t(*cold_restart)(void *), dnp3_restart_delay_t(*warm_restart)(void *), dnp3_freeze_result_t(*freeze_counters_all)(dnp3_freeze_type_t, dnp3_database_handle_t *, void *), dnp3_freeze_result_t(*freeze_counters_range)(uint16_t, uint16_t, dnp3_freeze_type_t, dnp3_database_handle_t *, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
static const char *	dnp3_broadcast_action_to_string (dnp3_broadcast_action_t value)
	Converts the enum to a string. More...
static dnp3_outstation_information_t	dnp3_outstation_information_init (void(*process_request_from_idle)(dnp3_request_header_t, void *), void(*broadcast_received)(dnp3_function_code_t, dnp3_broadcast_action_t, void *), void(*enter_solicited_confirm_wait)(uint8_t, void *), void(*solicited_confirm_timeout)(uint8_t, void *), void(*solicited_confirm_received)(uint8_t, void *), void(*solicited_confirm_wait_new_request)(void *), void(*wrong_solicited_confirm_seq)(uint8_t, uint8_t, void *), void(*unexpected_confirm)(bool, uint8_t, void *), void(*enter_unsolicited_confirm_wait)(uint8_t, void *), void(*unsolicited_confirm_timeout)(uint8_t, bool, void *), void(*unsolicited_confirmed)(uint8_t, void *), void(*clear_restart_iin)(void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
static const char *	dnp3_command_status_to_string (dnp3_command_status_t value)
	Converts the enum to a string. More...
static const char *	dnp3_operate_type_to_string (dnp3_operate_type_t value)
	Converts the enum to a string. More...
static dnp3_control_handler_t	dnp3_control_handler_init (void(*begin_fragment)(void *), void(*end_fragment)(dnp3_database_handle_t *, void *), dnp3_command_status_t(*select_g12v1)(dnp3_group12_var1_t, uint16_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*operate_g12v1)(dnp3_group12_var1_t, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*select_g41v1)(int32_t, uint16_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*operate_g41v1)(int32_t, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*select_g41v2)(int16_t, uint16_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*operate_g41v2)(int16_t, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*select_g41v3)(float, uint16_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*operate_g41v3)(float, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*select_g41v4)(double, uint16_t, dnp3_database_handle_t *, void *), dnp3_command_status_t(*operate_g41v4)(double, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
static const char *	dnp3_connection_state_to_string (dnp3_connection_state_t value)
	Converts the enum to a string. More...
static dnp3_connection_state_listener_t	dnp3_connection_state_listener_init (void(*on_change)(dnp3_connection_state_t, void *), void(*on_destroy)(void *arg), void *ctx)
	Initialize an instance of the interface. More...
dnp3_param_error_t	dnp3_outstation_create_serial_session (dnp3_runtime_t *runtime, const char *serial_path, dnp3_serial_settings_t settings, dnp3_outstation_config_t config, dnp3_outstation_application_t application, dnp3_outstation_information_t information, dnp3_control_handler_t control_handler, dnp3_outstation_t **out)
	Create an outstation instance running on a serial port. More...
dnp3_param_error_t	dnp3_outstation_create_serial_session_fault_tolerant (dnp3_runtime_t *runtime, const char *serial_path, dnp3_serial_settings_t settings, uint64_t open_retry_delay, dnp3_outstation_config_t config, dnp3_outstation_application_t application, dnp3_outstation_information_t information, dnp3_control_handler_t control_handler, dnp3_outstation_t **out)
	Create an outstation instance running on a serial port which is tolerant to the serial port being added and removed. More...
void	dnp3_outstation_destroy (dnp3_outstation_t *instance)
	Free resources of the outstation. More...
void	dnp3_outstation_transaction (dnp3_outstation_t *instance, dnp3_database_transaction_t callback)
	Acquire a mutex on the underlying database and apply a set of changes as a transaction. More...
dnp3_param_error_t	dnp3_outstation_set_decode_level (dnp3_outstation_t *instance, dnp3_decode_level_t level)
	Set decoding log level. More...
dnp3_address_filter_t *	dnp3_address_filter_any ()
	Create an address filter that accepts any IP address. More...
dnp3_param_error_t	dnp3_address_filter_create (const char *address, dnp3_address_filter_t **out)
	Create an address filter that matches a specific address or wildcards. More...
dnp3_param_error_t	dnp3_address_filter_add (dnp3_address_filter_t *instance, const char *address)
	Add an accepted IP address to the filter. More...
void	dnp3_address_filter_destroy (dnp3_address_filter_t *instance)
	Destroy an address filter. More...
static dnp3_tls_server_config_t	dnp3_tls_server_config_init (const char *dns_name, const char *peer_cert_path, const char *local_cert_path, const char *private_key_path, const char *password)
	construct the configuration with defaults More...
dnp3_param_error_t	dnp3_outstation_server_create_tcp_server (dnp3_runtime_t *runtime, dnp3_link_error_mode_t link_error_mode, const char *address, dnp3_outstation_server_t **out)
	Create a new TCP server. More...
dnp3_param_error_t	dnp3_outstation_server_create_tls_server (dnp3_runtime_t *runtime, dnp3_link_error_mode_t link_error_mode, const char *address, dnp3_tls_server_config_t tls_config, dnp3_outstation_server_t **out)
	Create a new TLS server. More...
dnp3_param_error_t	dnp3_outstation_server_add_outstation (dnp3_outstation_server_t *instance, dnp3_outstation_config_t config, dnp3_outstation_application_t application, dnp3_outstation_information_t information, dnp3_control_handler_t control_handler, dnp3_connection_state_listener_t listener, dnp3_address_filter_t *filter, dnp3_outstation_t **out)
	Add an outstation to the server. More...
dnp3_param_error_t	dnp3_outstation_server_bind (dnp3_outstation_server_t *instance)
	Bind the server to the port and starts listening. Also starts all the outstations associated to it. More...
void	dnp3_outstation_server_destroy (dnp3_outstation_server_t *instance)
	Gracefully shutdown all the outstations associated to this server, stops the server and release resources. More...
const char *	dnp3_version ()
	Get the version of the library as a string. More...

Detailed Description

C API for the dnp3 library

Macro Definition Documentation

DNP3_FLAG_CHATTER_FILTER

#define DNP3_FLAG_CHATTER_FILTER   0x20

Object value is changing state rapidly (device dependent meaning)

DNP3_FLAG_COMM_LOST

#define DNP3_FLAG_COMM_LOST   0x04

Object value represents the last value available before a communication failure occurred. Should never be set by originating devices.

DNP3_FLAG_DISCONTINUITY

#define DNP3_FLAG_DISCONTINUITY   0x40

Reported counter value cannot be compared against a prior value to obtain the correct count difference.

DNP3_FLAG_LOCAL_FORCED

#define DNP3_FLAG_LOCAL_FORCED   0x10

Object value is overridden by the device reporting this flag.

DNP3_FLAG_ONLINE

#define DNP3_FLAG_ONLINE   0x01

Object value is 'good' / 'valid' / 'nominal'.

DNP3_FLAG_OVER_RANGE

#define DNP3_FLAG_OVER_RANGE   0x20

Object's true exceeds the measurement range of the reported variation.

DNP3_FLAG_REFERENCE_ERR

#define DNP3_FLAG_REFERENCE_ERR   0x40

Object's value might not have the expected level of accuracy.

DNP3_FLAG_REMOTE_FORCED

#define DNP3_FLAG_REMOTE_FORCED   0x08

Object value is overridden in a downstream reporting device.

DNP3_FLAG_RESTART

#define DNP3_FLAG_RESTART   0x02

Object value has not been updated since device restart.

Typedef Documentation

dnp3_address_filter_t

typedef struct dnp3_address_filter_t dnp3_address_filter_t

Outstation address filter.

dnp3_analog_input_iterator_t

typedef struct dnp3_analog_input_iterator_t dnp3_analog_input_iterator_t

Iterator of analog_input.

dnp3_analog_output_status_iterator_t

typedef struct dnp3_analog_output_status_iterator_t dnp3_analog_output_status_iterator_t

Iterator of analog_output_status.

dnp3_binary_input_iterator_t

typedef struct dnp3_binary_input_iterator_t dnp3_binary_input_iterator_t

Iterator of binary_input.

dnp3_binary_output_status_iterator_t

typedef struct dnp3_binary_output_status_iterator_t dnp3_binary_output_status_iterator_t

Iterator of binary_output_status.

dnp3_byte_iterator_t

typedef struct dnp3_byte_iterator_t dnp3_byte_iterator_t

Iterator of uint8_t.

dnp3_command_set_t

typedef struct dnp3_command_set_t dnp3_command_set_t

Builder type used to construct command requests.

dnp3_counter_iterator_t

typedef struct dnp3_counter_iterator_t dnp3_counter_iterator_t

Iterator of counter.

dnp3_database_handle_t

typedef struct dnp3_database_handle_t dnp3_database_handle_t

handle used to perform transactions on the database

dnp3_database_t

typedef struct dnp3_database_t dnp3_database_t

Internal database access.

Warning

This object is only valid within a transaction

dnp3_double_bit_binary_input_iterator_t

typedef struct dnp3_double_bit_binary_input_iterator_t dnp3_double_bit_binary_input_iterator_t

Iterator of double_bit_binary_input.

dnp3_endpoint_list_t

typedef struct dnp3_endpoint_list_t dnp3_endpoint_list_t

List of IP endpoints.

You can write IP addresses or DNS names and the port to connect to. e.g. "127.0.0.1:20000" or "dnp3.myorg.com:20000".

dnp3_frozen_counter_iterator_t

typedef struct dnp3_frozen_counter_iterator_t dnp3_frozen_counter_iterator_t

Iterator of frozen_counter.

dnp3_master_channel_t

typedef struct dnp3_master_channel_t dnp3_master_channel_t

Represents a communication channel for a master station.

To communicate with a particular outstation, you need to add an association with dnp3_master_channel_add_association.

Warning

The class methods that return a value (e.g. as dnp3_master_channel_add_association) cannot be called from within a callback.

dnp3_octet_string_iterator_t

typedef struct dnp3_octet_string_iterator_t dnp3_octet_string_iterator_t

Iterator of octet_string.

dnp3_octet_string_value_t

typedef struct dnp3_octet_string_value_t dnp3_octet_string_value_t

Collection of octet_string_value.

dnp3_outstation_server_t

typedef struct dnp3_outstation_server_t dnp3_outstation_server_t

TCP server that listens for connections and routes the messages to outstations.

To add outstations to it, use dnp3_outstation_server_add_outstation. Once all the outstations are added, the server can be started with dnp3_outstation_server_bind.

dnp3_outstation_server_destroy is used to gracefully shutdown all the outstations and the server.

dnp3_outstation_t

typedef struct dnp3_outstation_t dnp3_outstation_t

Outstation handle.

Use this handle to modify the internal database.

dnp3_request_t

typedef struct dnp3_request_t dnp3_request_t

Custom request.

Whenever a method takes a request as a parameter, the request is internally copied. Therefore, it is possible to reuse the same requests over and over.

dnp3_runtime_t

typedef struct dnp3_runtime_t dnp3_runtime_t

Handle to the underlying runtime.

Enumeration Type Documentation

dnp3_app_decode_level_t

enum dnp3_app_decode_level_t

Controls how transmitted and received application-layer fragments are decoded at the INFO log level.

Enumerator
DNP3_APP_DECODE_LEVEL_NOTHING	Decode nothing.
DNP3_APP_DECODE_LEVEL_HEADER	Decode the header-only.
DNP3_APP_DECODE_LEVEL_OBJECT_HEADERS	Decode the header and the object headers.
DNP3_APP_DECODE_LEVEL_OBJECT_VALUES	Decode the header, the object headers, and the object values.

dnp3_auto_time_sync_t

enum dnp3_auto_time_sync_t

Automatic time synchronization configuration.

Enumerator
DNP3_AUTO_TIME_SYNC_NONE	Do not perform automatic time sync.
DNP3_AUTO_TIME_SYNC_LAN	Perform automatic time sync with Record Current Time (0x18) function code.
DNP3_AUTO_TIME_SYNC_NON_LAN	Perform automatic time sync with Delay Measurement (0x17) function code.

dnp3_broadcast_action_t

enum dnp3_broadcast_action_t

Enumeration describing how the outstation processed a broadcast request.

Enumerator
DNP3_BROADCAST_ACTION_PROCESSED	Outstation processed the broadcast.
DNP3_BROADCAST_ACTION_IGNORED_BY_CONFIGURATION	Outstation ignored the broadcast message b/c it is disabled by configuration.
DNP3_BROADCAST_ACTION_BAD_OBJECT_HEADERS	Outstation was unable to parse the object headers and ignored the request.
DNP3_BROADCAST_ACTION_UNSUPPORTED_FUNCTION	Outstation ignore the broadcast message b/c the function is not supported via Broadcast.

dnp3_certificate_mode_t

enum dnp3_certificate_mode_t

Determines how the certificate(s) presented by the peer are validated.

This validation always occurs after the handshake signature has been verified.

Enumerator
DNP3_CERTIFICATE_MODE_AUTHORITY_BASED	Validates the peer certificate against one or more configured trust anchors. This mode uses the default certificate verifier in `rustls` to ensure that the chain of certificates presented by the peer is valid against one of the configured trust anchors. The name verification is relaxed to allow for certificates that do not contain the SAN extension. In these cases the name is verified using the Common Name instead.
DNP3_CERTIFICATE_MODE_SELF_SIGNED	Validates that the peer presents a single certificate which is a byte-for-byte match against the configured peer certificate. The certificate is parsed only to ensure that the `NotBefore` and `NotAfter` are valid for the current system time.

dnp3_client_state_t

enum dnp3_client_state_t

State of the client connection.

Use by the dnp3_client_state_listener_t.

Enumerator
DNP3_CLIENT_STATE_DISABLED	Client is disabled and idle until enabled.
DNP3_CLIENT_STATE_CONNECTING	Client is trying to establish a connection to the remote device.
DNP3_CLIENT_STATE_CONNECTED	Client is connected to the remote device.
DNP3_CLIENT_STATE_WAIT_AFTER_FAILED_CONNECT	Failed to establish a connection, waiting before retrying.
DNP3_CLIENT_STATE_WAIT_AFTER_DISCONNECT	Client was disconnected, waiting before retrying.
DNP3_CLIENT_STATE_SHUTDOWN	Client is shutting down.

dnp3_command_error_t

enum dnp3_command_error_t

Result of a command.

Enumerator
DNP3_COMMAND_ERROR_OK	Success, i.e. no error occurred.
DNP3_COMMAND_ERROR_BAD_STATUS	Outstation indicated that a command was not SUCCESS.
DNP3_COMMAND_ERROR_HEADER_MISMATCH	Number of headers or objects in the response didn't match the number in the request.
DNP3_COMMAND_ERROR_TOO_MANY_REQUESTS	too many user requests queued
DNP3_COMMAND_ERROR_BAD_RESPONSE	response was malformed or contained object headers
DNP3_COMMAND_ERROR_RESPONSE_TIMEOUT	timeout occurred before receiving a response
DNP3_COMMAND_ERROR_WRITE_ERROR	insufficient buffer space to serialize the request
DNP3_COMMAND_ERROR_NO_CONNECTION	no connection
DNP3_COMMAND_ERROR_SHUTDOWN	master was shutdown
DNP3_COMMAND_ERROR_ASSOCIATION_REMOVED	association was removed mid-task

dnp3_command_mode_t

enum dnp3_command_mode_t

Command operation mode.

Enumerator
DNP3_COMMAND_MODE_DIRECT_OPERATE	Perform a Direct Operate (0x05)
DNP3_COMMAND_MODE_SELECT_BEFORE_OPERATE	Perform a Select and Operate (0x03 then 0x04)

dnp3_command_status_t

enum dnp3_command_status_t

Enumeration received from an outstation in response to command request.

Enumerator
DNP3_COMMAND_STATUS_SUCCESS	command was accepted, initiated, or queued (value == 0)
DNP3_COMMAND_STATUS_TIMEOUT	command timed out before completing (value == 1)
DNP3_COMMAND_STATUS_NO_SELECT	command requires being selected before operate, configuration issue (value == 2)
DNP3_COMMAND_STATUS_FORMAT_ERROR	bad control code or timing values (value == 3)
DNP3_COMMAND_STATUS_NOT_SUPPORTED	command is not implemented (value == 4)
DNP3_COMMAND_STATUS_ALREADY_ACTIVE	command is all ready in progress or its all ready in that mode (value == 5)
DNP3_COMMAND_STATUS_HARDWARE_ERROR	something is stopping the command, often a local/remote interlock (value == 6)
DNP3_COMMAND_STATUS_LOCAL	the function governed by the control is in local only control (value == 7)
DNP3_COMMAND_STATUS_TOO_MANY_OPS	the command has been done too often and has been throttled (value == 8)
DNP3_COMMAND_STATUS_NOT_AUTHORIZED	the command was rejected because the device denied it or an RTU intercepted it (value == 9)
DNP3_COMMAND_STATUS_AUTOMATION_INHIBIT	command not accepted because it was prevented or inhibited by a local automation process, such as interlocking logic or synchrocheck (value == 10)
DNP3_COMMAND_STATUS_PROCESSING_LIMITED	command not accepted because the device cannot process any more activities than are presently in progress (value == 11)
DNP3_COMMAND_STATUS_OUT_OF_RANGE	command not accepted because the value is outside the acceptable range permitted for this point (value == 12)
DNP3_COMMAND_STATUS_DOWNSTREAM_LOCAL	command not accepted because the outstation is forwarding the request to another downstream device which reported LOCAL (value == 13)
DNP3_COMMAND_STATUS_ALREADY_COMPLETE	command not accepted because the outstation has already completed the requested operation (value == 14)
DNP3_COMMAND_STATUS_BLOCKED	command not accepted because the requested function is specifically blocked at the outstation (value == 15)
DNP3_COMMAND_STATUS_CANCELED	command not accepted because the operation was cancelled (value == 16)
DNP3_COMMAND_STATUS_BLOCKED_OTHER_MASTER	command not accepted because another master is communicating with the outstation and has exclusive rights to operate this control point (value == 17)
DNP3_COMMAND_STATUS_DOWNSTREAM_FAIL	command not accepted because the outstation is forwarding the request to another downstream device which cannot be reached or is otherwise incapable of performing the request (value == 18)
DNP3_COMMAND_STATUS_NON_PARTICIPATING	(deprecated) indicates the outstation shall not issue or perform the control operation (value == 126)
DNP3_COMMAND_STATUS_UNKNOWN	captures any value not defined in the enumeration

dnp3_connection_state_t

enum dnp3_connection_state_t

Outstation connection state for connection-oriented transports, e.g. TCP.

Enumerator
DNP3_CONNECTION_STATE_CONNECTED	Connected to the master.
DNP3_CONNECTION_STATE_DISCONNECTED	Disconnected from the master.

dnp3_data_bits_t

enum dnp3_data_bits_t

Number of bits per character.

Enumerator
DNP3_DATA_BITS_FIVE	5 bits per character
DNP3_DATA_BITS_SIX	6 bits per character
DNP3_DATA_BITS_SEVEN	7 bits per character
DNP3_DATA_BITS_EIGHT	8 bits per character

dnp3_double_bit_t

enum dnp3_double_bit_t

Double-bit binary input value.

Enumerator
DNP3_DOUBLE_BIT_INTERMEDIATE	Transition between conditions.
DNP3_DOUBLE_BIT_DETERMINED_OFF	Determined to be OFF.
DNP3_DOUBLE_BIT_DETERMINED_ON	Determined to be ON.
DNP3_DOUBLE_BIT_INDETERMINATE	Abnormal or custom condition.

dnp3_event_analog_input_variation_t

enum dnp3_event_analog_input_variation_t

Event analog variation.

Enumerator
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR1	Analog input event - 32-bit without time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR2	Analog input event - 16-bit without time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR3	Analog input event - 32-bit with time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR4	Analog input event - 16-bit with time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR5	Analog input event - single-precision, floating-point without time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR6	Analog input event - double-precision, floating-point without time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR7	Analog input event - single-precision, floating-point with time.
DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR8	Analog input event - double-precision, floating-point with time.

dnp3_event_analog_output_status_variation_t

enum dnp3_event_analog_output_status_variation_t

Event analog output status variation.

Enumerator
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR1	Analog output event - 32-bit without time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR2	Analog output event - 16-bit without time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR3	Analog output event - 32-bit with time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR4	Analog output event - 16-bit with time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR5	Analog output event - single-precision, floating-point without time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR6	Analog output event - double-precision, floating-point without time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR7	Analog output event - single-precision, floating-point with time.
DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR8	Analog output event - double-precision, floating-point with time.

dnp3_event_binary_input_variation_t

enum dnp3_event_binary_input_variation_t

Event binary input variation.

Enumerator
DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR1	Binary input event - without time.
DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR2	Binary input event - with absolute time.
DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR3	Binary input event - with relative time.

dnp3_event_binary_output_status_variation_t

enum dnp3_event_binary_output_status_variation_t

Event binary output status variation.

Enumerator
DNP3_EVENT_BINARY_OUTPUT_STATUS_VARIATION_GROUP11_VAR1	Binary output event - status without time.
DNP3_EVENT_BINARY_OUTPUT_STATUS_VARIATION_GROUP11_VAR2	Binary output event - status with time.

dnp3_event_class_t

enum dnp3_event_class_t

Event class.

Enumerator
DNP3_EVENT_CLASS_NONE	Does not generate events.
DNP3_EVENT_CLASS_CLASS1	Class 1 event.
DNP3_EVENT_CLASS_CLASS2	Class 2 event.
DNP3_EVENT_CLASS_CLASS3	Class 3 event.

dnp3_event_counter_variation_t

enum dnp3_event_counter_variation_t

Event counter variation.

Enumerator
DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR1	Counter event - 32-bit with flag.
DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR2	Counter event - 16-bit with flag.
DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR5	Counter event - 32-bit with flag and time.
DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR6	Counter event - 16-bit with flag and time.

dnp3_event_double_bit_binary_input_variation_t

enum dnp3_event_double_bit_binary_input_variation_t

Event double-bit binary input variation.

Enumerator
DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR1	Double-bit binary input event - without time.
DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR2	Double-bit binary input event - with absolute time.
DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR3	Double-bit binary input event - with relative time.

dnp3_event_frozen_counter_variation_t

enum dnp3_event_frozen_counter_variation_t

Event frozen counter variation.

Enumerator
DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR1	Frozen Counter event - 32-bit with flag.
DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR2	Frozen Counter event - 16-bit with flag.
DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR5	Frozen Counter event - 32-bit with flag and time.
DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR6	Frozen Counter event - 16-bit with flag and time.

dnp3_event_mode_t

enum dnp3_event_mode_t

Controls how events are processed when updating values in the database.

Enumerator
DNP3_EVENT_MODE_DETECT	Detect events in a type dependent fashion. This is the default mode that should be used.
DNP3_EVENT_MODE_FORCE	Produce an event whether the value has changed or not.
DNP3_EVENT_MODE_SUPPRESS	Never produce an event regardless of change.

dnp3_flow_control_t

enum dnp3_flow_control_t

Flow control modes.

Enumerator
DNP3_FLOW_CONTROL_NONE	No flow control.
DNP3_FLOW_CONTROL_SOFTWARE	Flow control using XON/XOFF bytes.
DNP3_FLOW_CONTROL_HARDWARE	Flow control using RTS/CTS signals.

dnp3_freeze_result_t

enum dnp3_freeze_result_t

Result of a freeze operation.

Enumerator
DNP3_FREEZE_RESULT_OK	Freeze operation was successful.
DNP3_FREEZE_RESULT_PARAMETER_ERROR	The request parameters are nonsensical.
DNP3_FREEZE_RESULT_NOT_SUPPORTED	The demanded freeze operation is not supported by this device.

dnp3_freeze_type_t

enum dnp3_freeze_type_t

Freeze operation type.

Enumerator
DNP3_FREEZE_TYPE_IMMEDIATE_FREEZE	Copy the current value of a counter to the associated point.
DNP3_FREEZE_TYPE_FREEZE_AND_CLEAR	Copy the current value of a counter to the associated point and clear the current value to 0.

dnp3_function_code_t

enum dnp3_function_code_t

Application layer function code.

Enumerator
DNP3_FUNCTION_CODE_CONFIRM	Master sends this to an outstation to confirm the receipt of an Application Layer fragment (value == 0)
DNP3_FUNCTION_CODE_READ	Outstation shall return the data specified by the objects in the request (value == 1)
DNP3_FUNCTION_CODE_WRITE	Outstation shall store the data specified by the objects in the request (value == 2)
DNP3_FUNCTION_CODE_SELECT	Outstation shall select (or arm) the output points specified by the objects in the request in preparation for a subsequent operate command (value == 3)
DNP3_FUNCTION_CODE_OPERATE	Outstation shall activate the output points selected (or armed) by a previous select function code command (value == 4)
DNP3_FUNCTION_CODE_DIRECT_OPERATE	Outstation shall immediately actuate the output points specified by the objects in the request (value == 5)
DNP3_FUNCTION_CODE_DIRECT_OPERATE_NO_RESPONSE	Same as DirectOperate but outstation shall not send a response (value == 6)
DNP3_FUNCTION_CODE_IMMEDIATE_FREEZE	Outstation shall copy the point data values specified by the objects in the request to a separate freeze buffer (value == 7)
DNP3_FUNCTION_CODE_IMMEDIATE_FREEZE_NO_RESPONSE	Same as ImmediateFreeze but outstation shall not send a response (value == 8)
DNP3_FUNCTION_CODE_FREEZE_CLEAR	Outstation shall copy the point data values specified by the objects in the request into a separate freeze buffer and then clear the values (value == 9)
DNP3_FUNCTION_CODE_FREEZE_CLEAR_NO_RESPONSE	Same as FreezeClear but outstation shall not send a response (value == 10)
DNP3_FUNCTION_CODE_FREEZE_AT_TIME	Outstation shall copy the point data values specified by the objects in the request to a separate freeze buffer at the time and/or time intervals specified in a special time data information object (value == 11)
DNP3_FUNCTION_CODE_FREEZE_AT_TIME_NO_RESPONSE	Same as FreezeAtTime but outstation shall not send a response (value == 12)
DNP3_FUNCTION_CODE_COLD_RESTART	Outstation shall perform a complete reset of all hardware and software in the device (value == 13)
DNP3_FUNCTION_CODE_WARM_RESTART	Outstation shall reset only portions of the device (value == 14)
DNP3_FUNCTION_CODE_INITIALIZE_DATA	Obsolete-Do not use for new designs (value == 15)
DNP3_FUNCTION_CODE_INITIALIZE_APPLICATION	Outstation shall place the applications specified by the objects in the request into the ready to run state (value == 16)
DNP3_FUNCTION_CODE_START_APPLICATION	Outstation shall start running the applications specified by the objects in the request (value == 17)
DNP3_FUNCTION_CODE_STOP_APPLICATION	Outstation shall stop running the applications specified by the objects in the request (value == 18)
DNP3_FUNCTION_CODE_SAVE_CONFIGURATION	This code is deprecated-Do not use for new designs (value == 19)
DNP3_FUNCTION_CODE_ENABLE_UNSOLICITED	Enables outstation to initiate unsolicited responses from points specified by the objects in the request (value == 20)
DNP3_FUNCTION_CODE_DISABLE_UNSOLICITED	Prevents outstation from initiating unsolicited responses from points specified by the objects in the request (value == 21)
DNP3_FUNCTION_CODE_ASSIGN_CLASS	Outstation shall assign the events generated by the points specified by the objects in the request to one of the classes (value == 22)
DNP3_FUNCTION_CODE_DELAY_MEASURE	Outstation shall report the time it takes to process and initiate the transmission of its response (value == 23)
DNP3_FUNCTION_CODE_RECORD_CURRENT_TIME	Outstation shall save the time when the last octet of this message is received (value == 24)
DNP3_FUNCTION_CODE_OPEN_FILE	Outstation shall open a file (value == 25)
DNP3_FUNCTION_CODE_CLOSE_FILE	Outstation shall close a file (value == 26)
DNP3_FUNCTION_CODE_DELETE_FILE	Outstation shall delete a file (value == 27)
DNP3_FUNCTION_CODE_GET_FILE_INFO	Outstation shall retrieve information about a file (value == 28)
DNP3_FUNCTION_CODE_AUTHENTICATE_FILE	Outstation shall return a file authentication key (value == 29)
DNP3_FUNCTION_CODE_ABORT_FILE	Outstation shall abort a file transfer operation (value == 30)
DNP3_FUNCTION_CODE_RESPONSE	Master shall interpret this fragment as an Application Layer response to an ApplicationLayer request (value == 129)
DNP3_FUNCTION_CODE_UNSOLICITED_RESPONSE	Master shall interpret this fragment as an unsolicited response that was not prompted by an explicit request (value == 130)

dnp3_link_decode_level_t

enum dnp3_link_decode_level_t

Controls how transmitted and received link frames are decoded at the INFO log level.

Enumerator
DNP3_LINK_DECODE_LEVEL_NOTHING	Decode nothing.
DNP3_LINK_DECODE_LEVEL_HEADER	Decode the header.
DNP3_LINK_DECODE_LEVEL_PAYLOAD	Decode the header and the raw payload as hexadecimal.

dnp3_link_error_mode_t

enum dnp3_link_error_mode_t

Controls how errors in parsed link-layer frames are handled. This behavior is configurable for physical layers with built-in error correction like TCP as the connection might be through a terminal server.

Enumerator
DNP3_LINK_ERROR_MODE_DISCARD	Framing errors are discarded. The link-layer parser is reset on any error, and the parser begins scanning for 0x0564. This is always the behavior for serial ports.
DNP3_LINK_ERROR_MODE_CLOSE	Framing errors are bubbled up to calling code, closing the session. Suitable for physical layers that provide error correction like TCP.

dnp3_link_status_error_t

enum dnp3_link_status_error_t

Errors that can occur during a manually initiated link status check. See dnp3_master_channel_check_link_status.

Enumerator
DNP3_LINK_STATUS_ERROR_OK	Success, i.e. no error occurred.
DNP3_LINK_STATUS_ERROR_UNEXPECTED_RESPONSE	There was activity on the link, but it wasn't a LINK_STATUS.
DNP3_LINK_STATUS_ERROR_TOO_MANY_REQUESTS	too many user requests queued
DNP3_LINK_STATUS_ERROR_BAD_RESPONSE	response was malformed or contained object headers
DNP3_LINK_STATUS_ERROR_RESPONSE_TIMEOUT	timeout occurred before receiving a response
DNP3_LINK_STATUS_ERROR_WRITE_ERROR	insufficient buffer space to serialize the request
DNP3_LINK_STATUS_ERROR_NO_CONNECTION	no connection
DNP3_LINK_STATUS_ERROR_SHUTDOWN	master was shutdown
DNP3_LINK_STATUS_ERROR_ASSOCIATION_REMOVED	association was removed mid-task

dnp3_log_level_t

enum dnp3_log_level_t

Log level.

Used in dnp3_logger_t::on_message callback to identify the log level of a message.

Enumerator
DNP3_LOG_LEVEL_ERROR	Error log level.
DNP3_LOG_LEVEL_WARN	Warning log level.
DNP3_LOG_LEVEL_INFO	Information log level.
DNP3_LOG_LEVEL_DEBUG	Debugging log level.
DNP3_LOG_LEVEL_TRACE	Trace log level.

dnp3_log_output_format_t

enum dnp3_log_output_format_t

Describes how each log event is formatted.

Enumerator
DNP3_LOG_OUTPUT_FORMAT_TEXT	A simple text-based format.
DNP3_LOG_OUTPUT_FORMAT_JSON	Output formatted as JSON.

dnp3_min_tls_version_t

enum dnp3_min_tls_version_t

Minimum TLS version to allow.

Enumerator
DNP3_MIN_TLS_VERSION_V12	Allow TLS 1.2 and 1.3.
DNP3_MIN_TLS_VERSION_V13	Only allow TLS 1.3.

dnp3_nothing_t

enum dnp3_nothing_t

A single value enum which is used as a placeholder for futures that don't return a value.

Enumerator
DNP3_NOTHING_NOTHING	the only value this enum has

dnp3_op_type_t

enum dnp3_op_type_t

Operation Type field, used in conjunction with dnp3_trip_close_code_t to specify a control operation.

Enumerator
DNP3_OP_TYPE_NUL	NUL (0)
DNP3_OP_TYPE_PULSE_ON	PULSE_ON (1)
DNP3_OP_TYPE_PULSE_OFF	PULSE_OFF (2)
DNP3_OP_TYPE_LATCH_ON	LATCH_ON (3)
DNP3_OP_TYPE_LATCH_OFF	LATCH_OFF(4)

dnp3_operate_type_t

enum dnp3_operate_type_t

Enumeration describing how the master requested the control operation.

Enumerator
DNP3_OPERATE_TYPE_SELECT_BEFORE_OPERATE	control point was properly selected before the operate request
DNP3_OPERATE_TYPE_DIRECT_OPERATE	operate the control via a DirectOperate request
DNP3_OPERATE_TYPE_DIRECT_OPERATE_NO_ACK	operate the control via a DirectOperateNoAck request

dnp3_param_error_t

enum dnp3_param_error_t

Error type used throughout the library.

Enumerator
DNP3_PARAM_ERROR_OK	Success, i.e. no error occurred.
DNP3_PARAM_ERROR_INVALID_TIMEOUT	The supplied timeout value is too small or too large.
DNP3_PARAM_ERROR_NULL_PARAMETER	Null parameter.
DNP3_PARAM_ERROR_NO_SUPPORT	Native library was compiled without support for this feature.
DNP3_PARAM_ERROR_ASSOCIATION_DOES_NOT_EXIST	The specified association does not exist.
DNP3_PARAM_ERROR_ASSOCIATION_DUPLICATE_ADDRESS	Duplicate association address.
DNP3_PARAM_ERROR_INVALID_SOCKET_ADDRESS	Invalid socket address.
DNP3_PARAM_ERROR_INVALID_DNP3_ADDRESS	Invalid link-layer DNP3 address.
DNP3_PARAM_ERROR_INVALID_BUFFER_SIZE	Invalid buffer size.
DNP3_PARAM_ERROR_ADDRESS_FILTER_CONFLICT	Conflict in the address filter specification.
DNP3_PARAM_ERROR_SERVER_ALREADY_STARTED	Server already started.
DNP3_PARAM_ERROR_SERVER_BIND_ERROR	Server failed to bind to the specified port.
DNP3_PARAM_ERROR_MASTER_ALREADY_SHUTDOWN	Master was already shutdown.
DNP3_PARAM_ERROR_RUNTIME_CREATION_FAILURE	Failed to create Tokio runtime.
DNP3_PARAM_ERROR_RUNTIME_DESTROYED	Runtime has already been disposed.
DNP3_PARAM_ERROR_RUNTIME_CANNOT_BLOCK_WITHIN_ASYNC	Runtime cannot execute blocking call within asynchronous context.
DNP3_PARAM_ERROR_LOGGING_ALREADY_CONFIGURED	Logging can only be configured once.
DNP3_PARAM_ERROR_POINT_DOES_NOT_EXIST	Point does not exist.
DNP3_PARAM_ERROR_INVALID_PEER_CERTIFICATE	Invalid peer certificate file.
DNP3_PARAM_ERROR_INVALID_LOCAL_CERTIFICATE	Invalid local certificate file.
DNP3_PARAM_ERROR_INVALID_PRIVATE_KEY	Invalid private key file.
DNP3_PARAM_ERROR_INVALID_DNS_NAME	Invalid DNS name.
DNP3_PARAM_ERROR_OTHER_TLS_ERROR	Other TLS error.

dnp3_parity_t

enum dnp3_parity_t

Parity checking modes.

Enumerator
DNP3_PARITY_NONE	No parity bit.
DNP3_PARITY_ODD	Parity bit sets odd number of 1 bits.
DNP3_PARITY_EVEN	Parity bit sets even number of 1 bits.

dnp3_phys_decode_level_t

enum dnp3_phys_decode_level_t

Controls how data transmitted at the physical layer (TCP, serial, etc) is logged.

Enumerator
DNP3_PHYS_DECODE_LEVEL_NOTHING	Log nothing.
DNP3_PHYS_DECODE_LEVEL_LENGTH	Log only the length of data that is sent and received.
DNP3_PHYS_DECODE_LEVEL_DATA	Log the length and the actual data that is sent and received.

dnp3_port_state_t

enum dnp3_port_state_t

State of the serial port.

Enumerator
DNP3_PORT_STATE_DISABLED	Disabled until enabled.
DNP3_PORT_STATE_WAIT	Waiting to perform an open retry.
DNP3_PORT_STATE_OPEN	Port is open.
DNP3_PORT_STATE_SHUTDOWN	Task has been shut down.

dnp3_qualifier_code_t

enum dnp3_qualifier_code_t

Qualifier code used in the response.

Enumerator
DNP3_QUALIFIER_CODE_RANGE8	8-bit start stop (0x00)
DNP3_QUALIFIER_CODE_RANGE16	16-bit start stop (0x01)
DNP3_QUALIFIER_CODE_ALL_OBJECTS	All objects (0x06)
DNP3_QUALIFIER_CODE_COUNT8	8-bit count (0x07)
DNP3_QUALIFIER_CODE_COUNT16	16-bit count (0x08)
DNP3_QUALIFIER_CODE_COUNT_AND_PREFIX_8	8-bit count and prefix (0x17)
DNP3_QUALIFIER_CODE_COUNT_AND_PREFIX_16	16-bit count and prefix (0x28)
DNP3_QUALIFIER_CODE_FREE_FORMAT_16	16-bit free format (0x5B)

dnp3_read_error_t

enum dnp3_read_error_t

Errors that can occur during a read operation.

Enumerator
DNP3_READ_ERROR_OK	Success, i.e. no error occurred.
DNP3_READ_ERROR_TOO_MANY_REQUESTS	too many user requests queued
DNP3_READ_ERROR_BAD_RESPONSE	response was malformed or contained object headers
DNP3_READ_ERROR_RESPONSE_TIMEOUT	timeout occurred before receiving a response
DNP3_READ_ERROR_WRITE_ERROR	insufficient buffer space to serialize the request
DNP3_READ_ERROR_NO_CONNECTION	no connection
DNP3_READ_ERROR_SHUTDOWN	master was shutdown
DNP3_READ_ERROR_ASSOCIATION_REMOVED	association was removed mid-task

dnp3_read_type_t

enum dnp3_read_type_t

Describes the source of a read event.

Enumerator
DNP3_READ_TYPE_STARTUP_INTEGRITY	Startup integrity poll.
DNP3_READ_TYPE_UNSOLICITED	Unsolicited message.
DNP3_READ_TYPE_SINGLE_POLL	Single poll requested by the user.
DNP3_READ_TYPE_PERIODIC_POLL	Periodic poll configured by the user.

dnp3_response_function_t

enum dnp3_response_function_t

Type of response.

Enumerator
DNP3_RESPONSE_FUNCTION_RESPONSE	Solicited response.
DNP3_RESPONSE_FUNCTION_UNSOLICITED_RESPONSE	Unsolicited response.

dnp3_restart_delay_type_t

enum dnp3_restart_delay_type_t

Type of restart delay value. Used by dnp3_restart_delay_t.

Enumerator
DNP3_RESTART_DELAY_TYPE_NOT_SUPPORTED	Restart mode not supported.
DNP3_RESTART_DELAY_TYPE_SECONDS	Value is in seconds (corresponds to g51v1)
DNP3_RESTART_DELAY_TYPE_MILLI_SECONDS	Value is in milliseconds (corresponds to g51v2)

dnp3_restart_error_t

enum dnp3_restart_error_t

Errors that can occur during a cold/warm restart operation.

Enumerator
DNP3_RESTART_ERROR_OK	Success, i.e. no error occurred.
DNP3_RESTART_ERROR_TOO_MANY_REQUESTS	too many user requests queued
DNP3_RESTART_ERROR_BAD_RESPONSE	response was malformed or contained object headers
DNP3_RESTART_ERROR_RESPONSE_TIMEOUT	timeout occurred before receiving a response
DNP3_RESTART_ERROR_WRITE_ERROR	insufficient buffer space to serialize the request
DNP3_RESTART_ERROR_NO_CONNECTION	no connection
DNP3_RESTART_ERROR_SHUTDOWN	master was shutdown
DNP3_RESTART_ERROR_ASSOCIATION_REMOVED	association was removed mid-task

dnp3_static_analog_input_variation_t

enum dnp3_static_analog_input_variation_t

Static analog variation.

Enumerator
DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR1	Analog input - 32-bit with flag.
DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR2	Analog input - 16-bit with flag.
DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR3	Analog input - 32-bit without flag.
DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR4	Analog input - 16-bit without flag.
DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR5	Analog input - single-precision, floating-point with flag.
DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR6	Analog input - double-precision, floating-point with flag.

dnp3_static_analog_output_status_variation_t

enum dnp3_static_analog_output_status_variation_t

Static analog output status variation.

Enumerator
DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR1	Analog output status - 32-bit with flag.
DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR2	Analog output status - 16-bit with flag.
DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR3	Analog output status - single-precision, floating-point with flag.
DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR4	Analog output status - double-precision, floating-point with flag.

dnp3_static_binary_input_variation_t

enum dnp3_static_binary_input_variation_t

Static binary input variation.

Enumerator
DNP3_STATIC_BINARY_INPUT_VARIATION_GROUP1_VAR1	Binary input - packed format.
DNP3_STATIC_BINARY_INPUT_VARIATION_GROUP1_VAR2	Binary input - with flags.

dnp3_static_binary_output_status_variation_t

enum dnp3_static_binary_output_status_variation_t

Static binary output status variation.

Enumerator
DNP3_STATIC_BINARY_OUTPUT_STATUS_VARIATION_GROUP10_VAR1	Binary output - packed format.
DNP3_STATIC_BINARY_OUTPUT_STATUS_VARIATION_GROUP10_VAR2	Binary output - output status with flags.

dnp3_static_counter_variation_t

enum dnp3_static_counter_variation_t

Static counter variation.

Enumerator
DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR1	Counter - 32-bit with flag.
DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR2	Counter - 16-bit with flag.
DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR5	Counter - 32-bit without flag.
DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR6	Counter - 16-bit without flag.

dnp3_static_double_bit_binary_input_variation_t

enum dnp3_static_double_bit_binary_input_variation_t

Static double-bit binary input variation.

Enumerator
DNP3_STATIC_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP3_VAR1	Double-bit binary input - packed format.
DNP3_STATIC_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP3_VAR2	Double-bit binary input - with flags.

dnp3_static_frozen_counter_variation_t

enum dnp3_static_frozen_counter_variation_t

Static frozen counter variation.

Enumerator
DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR1	Frozen Counter - 32-bit with flag.
DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR2	Frozen Counter - 16-bit with flag.
DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR5	Frozen Counter - 32-bit with flag and time.
DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR6	Frozen Counter - 16-bit with flag and time.
DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR9	Frozen Counter - 32-bit without flag.
DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR10	Frozen Counter - 16-bit without flag.

dnp3_stop_bits_t

enum dnp3_stop_bits_t

Number of stop bits.

Enumerator
DNP3_STOP_BITS_ONE	One stop bit.
DNP3_STOP_BITS_TWO	Two stop bits.

dnp3_task_error_t

enum dnp3_task_error_t

Task error used in dnp3_association_information_t.

Enumerator
DNP3_TASK_ERROR_TOO_MANY_REQUESTS	too many user requests queued
DNP3_TASK_ERROR_BAD_RESPONSE	response was malformed or contained object headers
DNP3_TASK_ERROR_RESPONSE_TIMEOUT	timeout occurred before receiving a response
DNP3_TASK_ERROR_WRITE_ERROR	insufficient buffer space to serialize the request
DNP3_TASK_ERROR_NO_CONNECTION	no connection
DNP3_TASK_ERROR_SHUTDOWN	master was shutdown
DNP3_TASK_ERROR_ASSOCIATION_REMOVED	association was removed mid-task

dnp3_task_type_t

enum dnp3_task_type_t

Task type used in dnp3_association_information_t.

Enumerator
DNP3_TASK_TYPE_USER_READ	User-defined read request.
DNP3_TASK_TYPE_PERIODIC_POLL	Periodic poll task.
DNP3_TASK_TYPE_STARTUP_INTEGRITY	Startup integrity scan.
DNP3_TASK_TYPE_AUTO_EVENT_SCAN	Automatic event scan caused by RESTART IIN bit detection.
DNP3_TASK_TYPE_COMMAND	Command request.
DNP3_TASK_TYPE_CLEAR_RESTART_BIT	Clear RESTART IIN bit.
DNP3_TASK_TYPE_ENABLE_UNSOLICITED	Enable unsolicited startup request.
DNP3_TASK_TYPE_DISABLE_UNSOLICITED	Disable unsolicited startup request.
DNP3_TASK_TYPE_TIME_SYNC	Time synchronisation task.
DNP3_TASK_TYPE_RESTART	Cold or warm restart task.

dnp3_time_format_t

enum dnp3_time_format_t

Describes if and how the time will be formatted in log messages.

Enumerator
DNP3_TIME_FORMAT_NONE	Don't format the timestamp as part of the message.
DNP3_TIME_FORMAT_RFC_3339	Format the time using RFC 3339.
DNP3_TIME_FORMAT_SYSTEM	Format the time in a human readable format e.g. 'Jun 25 14:27:12.955'.

dnp3_time_quality_t

enum dnp3_time_quality_t

Timestamp quality.

Enumerator
DNP3_TIME_QUALITY_SYNCHRONIZED_TIME	The timestamp is UTC synchronized at the remote device.
DNP3_TIME_QUALITY_UNSYNCHRONIZED_TIME	The device indicates the timestamp may be not be synchronized.
DNP3_TIME_QUALITY_INVALID_TIME	Timestamp is not valid, ignore the value and use a local timestamp.

dnp3_time_sync_error_t

enum dnp3_time_sync_error_t

Possible errors that can occur during a time synchronization procedure.

Enumerator
DNP3_TIME_SYNC_ERROR_OK	Success, i.e. no error occurred.
DNP3_TIME_SYNC_ERROR_CLOCK_ROLLBACK	Detected a clock rollback.
DNP3_TIME_SYNC_ERROR_SYSTEM_TIME_NOT_UNIX	The system time cannot be converted to a Unix timestamp.
DNP3_TIME_SYNC_ERROR_BAD_OUTSTATION_TIME_DELAY	Outstation time delay exceeded the response delay.
DNP3_TIME_SYNC_ERROR_OVERFLOW	Overflow in calculation.
DNP3_TIME_SYNC_ERROR_STILL_NEEDS_TIME	Outstation did not clear the NEED_TIME IIN bit.
DNP3_TIME_SYNC_ERROR_SYSTEM_TIME_NOT_AVAILABLE	System time not available.
DNP3_TIME_SYNC_ERROR_IIN_ERROR	Outstation indicated an error.
DNP3_TIME_SYNC_ERROR_TOO_MANY_REQUESTS	too many user requests queued
DNP3_TIME_SYNC_ERROR_BAD_RESPONSE	response was malformed or contained object headers
DNP3_TIME_SYNC_ERROR_RESPONSE_TIMEOUT	timeout occurred before receiving a response
DNP3_TIME_SYNC_ERROR_WRITE_ERROR	insufficient buffer space to serialize the request
DNP3_TIME_SYNC_ERROR_NO_CONNECTION	no connection
DNP3_TIME_SYNC_ERROR_SHUTDOWN	master was shutdown
DNP3_TIME_SYNC_ERROR_ASSOCIATION_REMOVED	association was removed mid-task

dnp3_time_sync_mode_t

enum dnp3_time_sync_mode_t

Time synchronization mode.

Enumerator
DNP3_TIME_SYNC_MODE_LAN	Perform a LAN time sync with Record Current Time (0x18) function code.
DNP3_TIME_SYNC_MODE_NON_LAN	Perform a non-LAN time sync with Delay Measurement (0x17) function code.

dnp3_transport_decode_level_t

enum dnp3_transport_decode_level_t

Controls how transmitted and received transport segments are decoded at the INFO log level.

Enumerator
DNP3_TRANSPORT_DECODE_LEVEL_NOTHING	Decode nothing.
DNP3_TRANSPORT_DECODE_LEVEL_HEADER	Decode the header.
DNP3_TRANSPORT_DECODE_LEVEL_PAYLOAD	Decode the header and the raw payload as hexadecimal.

dnp3_trip_close_code_t

enum dnp3_trip_close_code_t

Trip-Close Code field, used in conjunction with dnp3_op_type_t to specify a control operation.

Enumerator
DNP3_TRIP_CLOSE_CODE_NUL	NUL (0)
DNP3_TRIP_CLOSE_CODE_CLOSE	CLOSE (1)
DNP3_TRIP_CLOSE_CODE_TRIP	TRIP (2)
DNP3_TRIP_CLOSE_CODE_RESERVED	RESERVED (3)

dnp3_variation_t

enum dnp3_variation_t

Group/Variation.

Enumerator
DNP3_VARIATION_GROUP1_VAR0	Binary Input - Default variation.
DNP3_VARIATION_GROUP1_VAR1	Binary Input - Packed format.
DNP3_VARIATION_GROUP1_VAR2	Binary Input - With flags.
DNP3_VARIATION_GROUP2_VAR0	Binary Input Event - Default variation.
DNP3_VARIATION_GROUP2_VAR1	Binary Input Event - Without time.
DNP3_VARIATION_GROUP2_VAR2	Binary Input Event - With absolute time.
DNP3_VARIATION_GROUP2_VAR3	Binary Input Event - With relative time.
DNP3_VARIATION_GROUP3_VAR0	Double-bit Binary Input - Default variation.
DNP3_VARIATION_GROUP3_VAR1	Double-bit Binary Input - Packed format.
DNP3_VARIATION_GROUP3_VAR2	Double-bit Binary Input - With flags.
DNP3_VARIATION_GROUP4_VAR0	Double-bit Binary Input Event - Default variation.
DNP3_VARIATION_GROUP4_VAR1	Double-bit Binary Input Event - Without time.
DNP3_VARIATION_GROUP4_VAR2	Double-bit Binary Input Event - With absolute time.
DNP3_VARIATION_GROUP4_VAR3	Double-bit Binary Input Event - With relative time.
DNP3_VARIATION_GROUP10_VAR0	Binary Output - Default variation.
DNP3_VARIATION_GROUP10_VAR1	Binary Output - Packed format.
DNP3_VARIATION_GROUP10_VAR2	Binary Output - With flags.
DNP3_VARIATION_GROUP11_VAR0	Binary Output Event - Default variation.
DNP3_VARIATION_GROUP11_VAR1	Binary Output Event - Without time.
DNP3_VARIATION_GROUP11_VAR2	Binary Output Event - With time.
DNP3_VARIATION_GROUP12_VAR0	Binary Output Command - Control Relay Output Block.
DNP3_VARIATION_GROUP12_VAR1	Binary Output Command - Pattern Control Block.
DNP3_VARIATION_GROUP20_VAR0	Counter - Default variation.
DNP3_VARIATION_GROUP20_VAR1	Counter - 32-bit with flags.
DNP3_VARIATION_GROUP20_VAR2	Counter - 16-bit with flags.
DNP3_VARIATION_GROUP20_VAR5	Counter - 32-bit without flag.
DNP3_VARIATION_GROUP20_VAR6	Counter - 16-bit without flag.
DNP3_VARIATION_GROUP21_VAR0	Frozen Counter - Default variation.
DNP3_VARIATION_GROUP21_VAR1	Frozen Counter - 32-bit with flags.
DNP3_VARIATION_GROUP21_VAR2	Frozen Counter - 16-bit with flags.
DNP3_VARIATION_GROUP21_VAR5	Frozen Counter - 32-bit with flags and time.
DNP3_VARIATION_GROUP21_VAR6	Frozen Counter - 16-bit with flags and time.
DNP3_VARIATION_GROUP21_VAR9	Frozen Counter - 32-bit without flag.
DNP3_VARIATION_GROUP21_VAR10	Frozen Counter - 16-bit without flag.
DNP3_VARIATION_GROUP22_VAR0	Counter Event - Default variation.
DNP3_VARIATION_GROUP22_VAR1	Counter Event - 32-bit with flags.
DNP3_VARIATION_GROUP22_VAR2	Counter Event - 16-bit with flags.
DNP3_VARIATION_GROUP22_VAR5	Counter Event - 32-bit with flags and time.
DNP3_VARIATION_GROUP22_VAR6	Counter Event - 16-bit with flags and time.
DNP3_VARIATION_GROUP23_VAR0	Frozen Counter Event - Default variation.
DNP3_VARIATION_GROUP23_VAR1	Frozen Counter Event - 32-bit with flags.
DNP3_VARIATION_GROUP23_VAR2	Frozen Counter Event - 16-bit with flags.
DNP3_VARIATION_GROUP23_VAR5	Frozen Counter Event - 32-bit with flags and time.
DNP3_VARIATION_GROUP23_VAR6	Frozen Counter Event - 16-bit with flags and time.
DNP3_VARIATION_GROUP30_VAR0	Analog Input - Default variation.
DNP3_VARIATION_GROUP30_VAR1	Analog Input - 32-bit with flags.
DNP3_VARIATION_GROUP30_VAR2	Analog Input - 16-bit with flags.
DNP3_VARIATION_GROUP30_VAR3	Analog Input - 32-bit without flag.
DNP3_VARIATION_GROUP30_VAR4	Analog Input - 16-bit without flag.
DNP3_VARIATION_GROUP30_VAR5	Analog Input - Single-precision floating point with flags.
DNP3_VARIATION_GROUP30_VAR6	Analog Input - Double-precision floating point with flags.
DNP3_VARIATION_GROUP32_VAR0	Analog Input Event - Default variation.
DNP3_VARIATION_GROUP32_VAR1	Analog Input Event - 32-bit without time.
DNP3_VARIATION_GROUP32_VAR2	Analog Input Event - 16-bit without time.
DNP3_VARIATION_GROUP32_VAR3	Analog Input Event - 32-bit with time.
DNP3_VARIATION_GROUP32_VAR4	Analog Input Event - 16-bit with time.
DNP3_VARIATION_GROUP32_VAR5	Analog Input Event - Single-precision floating point without time.
DNP3_VARIATION_GROUP32_VAR6	Analog Input Event - Double-precision floating point without time.
DNP3_VARIATION_GROUP32_VAR7	Analog Input Event - Single-precision floating point with time.
DNP3_VARIATION_GROUP32_VAR8	Analog Input Event - Double-precision floating point with time.
DNP3_VARIATION_GROUP40_VAR0	Analog Output Status - Default variation.
DNP3_VARIATION_GROUP40_VAR1	Analog Output Status - 32-bit with flags.
DNP3_VARIATION_GROUP40_VAR2	Analog Output Status - 16-bit with flags.
DNP3_VARIATION_GROUP40_VAR3	Analog Output Status - Single-precision floating point with flags.
DNP3_VARIATION_GROUP40_VAR4	Analog Output Status - Double-precision floating point with flags.
DNP3_VARIATION_GROUP41_VAR0	Analog Output - Default variation.
DNP3_VARIATION_GROUP41_VAR1	Analog Output - 32-bit.
DNP3_VARIATION_GROUP41_VAR2	Analog Output - 16-bit.
DNP3_VARIATION_GROUP41_VAR3	Analog Output - Single-precision floating point.
DNP3_VARIATION_GROUP41_VAR4	Analog Output - Double-precision floating point.
DNP3_VARIATION_GROUP42_VAR0	Analog Output Event - Default variation.
DNP3_VARIATION_GROUP42_VAR1	Analog Output Event - 32-bit without time.
DNP3_VARIATION_GROUP42_VAR2	Analog Output Event - 16-bit without time.
DNP3_VARIATION_GROUP42_VAR3	Analog Output Event - 32-bit with time.
DNP3_VARIATION_GROUP42_VAR4	Analog Output Event - 16-bit with time.
DNP3_VARIATION_GROUP42_VAR5	Analog Output Event - Single-precision floating point without time.
DNP3_VARIATION_GROUP42_VAR6	Analog Output Event - Double-precision floating point without time.
DNP3_VARIATION_GROUP42_VAR7	Analog Output Event - Single-preicions floating point with time.
DNP3_VARIATION_GROUP42_VAR8	Analog Output Event - Double-preicions floating point with time.
DNP3_VARIATION_GROUP50_VAR1	Time and Date - Absolute time.
DNP3_VARIATION_GROUP50_VAR3	Time and Date - Absolute time at last recorded time.
DNP3_VARIATION_GROUP50_VAR4	Time and Date - Indexed absolute time and long interval.
DNP3_VARIATION_GROUP51_VAR1	Time and date CTO - Absolute time, synchronized.
DNP3_VARIATION_GROUP51_VAR2	Time and date CTO - Absolute time, unsynchronized.
DNP3_VARIATION_GROUP52_VAR1	Time delay - Coarse.
DNP3_VARIATION_GROUP52_VAR2	Time delay - Fine.
DNP3_VARIATION_GROUP60_VAR1	Class objects - Class 0 data.
DNP3_VARIATION_GROUP60_VAR2	Class objects - Class 1 data.
DNP3_VARIATION_GROUP60_VAR3	Class objects - Class 2 data.
DNP3_VARIATION_GROUP60_VAR4	Class objects - Class 3 data.
DNP3_VARIATION_GROUP80_VAR1	Internal Indications - Packed format.
DNP3_VARIATION_GROUP110	Octet String.
DNP3_VARIATION_GROUP111	Octet String Event.

dnp3_write_time_result_t

enum dnp3_write_time_result_t

Write time result used by dnp3_outstation_application_t::write_absolute_time.

Enumerator
DNP3_WRITE_TIME_RESULT_OK	The write time operation succeeded.
DNP3_WRITE_TIME_RESULT_PARAMETER_ERROR	The request parameters are nonsensical.
DNP3_WRITE_TIME_RESULT_NOT_SUPPORTED	Writing time is not supported by this outstation (translated to NO_FUNC_CODE_SUPPORT).

Function Documentation

dnp3_address_filter_add()

dnp3_param_error_t dnp3_address_filter_add	(	dnp3_address_filter_t *	instance,
		const char *	address
	)

Add an accepted IP address to the filter.

Parameters

instance	Instance of dnp3_address_filter_t
address	IP address to add

Returns

Error code

dnp3_address_filter_any()

dnp3_address_filter_t * dnp3_address_filter_any

(

)

Create an address filter that accepts any IP address.

Returns

Address filter

dnp3_address_filter_create()

dnp3_param_error_t dnp3_address_filter_create	(	const char *	address,
		dnp3_address_filter_t **	out
	)

Create an address filter that matches a specific address or wildcards.

Examples: 192.168.1.26, 192.168.0.*, *.*.*.*

Wildcards are only supported for IPv4 addresses

Parameters

address	IP address to accept
out	Instance of dnp3_address_filter_t

Returns

Error code

dnp3_address_filter_destroy()

void dnp3_address_filter_destroy

(

dnp3_address_filter_t *

instance

)

Destroy an address filter.

Parameters

instance

Instance of dnp3_address_filter_t to destroy

dnp3_analog_input_config_init()

static dnp3_analog_input_config_t dnp3_analog_input_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_analog_input_config_t::static_variation : DNP3_STATIC_ANALOG_INPUT_VARIATION_GROUP30_VAR1
• dnp3_analog_input_config_t::event_variation : DNP3_EVENT_ANALOG_INPUT_VARIATION_GROUP32_VAR1
• dnp3_analog_input_config_t::deadband : 0

Returns

New instance of dnp3_analog_input_config_t

dnp3_analog_input_init()

static dnp3_analog_input_t dnp3_analog_input_init ( uint16_t  index, double  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_analog_input_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_analog_input_t

dnp3_analog_input_iterator_next()

dnp3_analog_input_t * dnp3_analog_input_iterator_next

(

dnp3_analog_input_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_analog_output_status_config_init()

static dnp3_analog_output_status_config_t dnp3_analog_output_status_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_analog_output_status_config_t::static_variation : DNP3_STATIC_ANALOG_OUTPUT_STATUS_VARIATION_GROUP40_VAR1
• dnp3_analog_output_status_config_t::event_variation : DNP3_EVENT_ANALOG_OUTPUT_STATUS_VARIATION_GROUP42_VAR1
• dnp3_analog_output_status_config_t::deadband : 0

Returns

New instance of dnp3_analog_output_status_config_t

dnp3_analog_output_status_init()

static dnp3_analog_output_status_t dnp3_analog_output_status_init ( uint16_t  index, double  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_analog_output_status_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_analog_output_status_t

dnp3_analog_output_status_iterator_next()

dnp3_analog_output_status_t * dnp3_analog_output_status_iterator_next

(

dnp3_analog_output_status_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_app_decode_level_to_string()

static const char * dnp3_app_decode_level_to_string ( dnp3_app_decode_level_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_application_iin_init()

static dnp3_application_iin_t dnp3_application_iin_init ( )

static

Initialize all fields in dnp3_application_iin_t to false.

Note

Values are initialized to:

• dnp3_application_iin_t::need_time : false
• dnp3_application_iin_t::local_control : false
• dnp3_application_iin_t::device_trouble : false
• dnp3_application_iin_t::config_corrupt : false

Returns

New instance of dnp3_application_iin_t

dnp3_association_config_init()

static dnp3_association_config_t dnp3_association_config_init ( dnp3_event_classes_t  disable_unsol_classes, dnp3_event_classes_t  enable_unsol_classes, dnp3_classes_t  startup_integrity_classes, dnp3_event_classes_t  event_scan_on_events_available  )

static

Initialize the configuration with the specified values.

Note

Values are initialized to:

• dnp3_association_config_t::response_timeout : 5000ms
• dnp3_association_config_t::auto_time_sync : DNP3_AUTO_TIME_SYNC_NONE
• dnp3_association_config_t::auto_tasks_retry_strategy : Default dnp3_retry_strategy_t
• dnp3_association_config_t::keep_alive_timeout : 60s
• dnp3_association_config_t::auto_integrity_scan_on_buffer_overflow : true
• dnp3_association_config_t::max_queued_user_requests : 16

Parameters

disable_unsol_classes	Classes to disable unsolicited responses at startup
enable_unsol_classes	Classes to enable unsolicited responses at startup
startup_integrity_classes	Startup integrity classes to ask on master startup and when an outstation restart is detected.
event_scan_on_events_available	Classes to automatically send reads when the IIN bit is asserted

Returns

New instance of dnp3_association_config_t

dnp3_association_handler_init()

static dnp3_association_handler_t dnp3_association_handler_init ( dnp3_utc_timestamp_t(*)(void *)  get_current_time, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

get_current_time	Returns the current time or an invalid time if none is available
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_association_information_init()

static dnp3_association_information_t dnp3_association_information_init ( void(*)(dnp3_task_type_t, dnp3_function_code_t, uint8_t, void *)  task_start, void(*)(dnp3_task_type_t, dnp3_function_code_t, uint8_t, void *)  task_success, void(*)(dnp3_task_type_t, dnp3_task_error_t, void *)  task_fail, void(*)(bool, uint8_t, void *)  unsolicited_response, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

task_start	Called when a new task is started
task_success	Called when a task successfully completes
task_fail	Called when a task fails
unsolicited_response	Called when an unsolicited response is received
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_auto_time_sync_to_string()

static const char * dnp3_auto_time_sync_to_string ( dnp3_auto_time_sync_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_binary_input_config_init()

static dnp3_binary_input_config_t dnp3_binary_input_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_binary_input_config_t::static_variation : DNP3_STATIC_BINARY_INPUT_VARIATION_GROUP1_VAR1
• dnp3_binary_input_config_t::event_variation : DNP3_EVENT_BINARY_INPUT_VARIATION_GROUP2_VAR1

Returns

New instance of dnp3_binary_input_config_t

dnp3_binary_input_init()

static dnp3_binary_input_t dnp3_binary_input_init ( uint16_t  index, bool  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_binary_input_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_binary_input_t

dnp3_binary_input_iterator_next()

dnp3_binary_input_t * dnp3_binary_input_iterator_next

(

dnp3_binary_input_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_binary_output_status_config_init()

static dnp3_binary_output_status_config_t dnp3_binary_output_status_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_binary_output_status_config_t::static_variation : DNP3_STATIC_BINARY_OUTPUT_STATUS_VARIATION_GROUP10_VAR1
• dnp3_binary_output_status_config_t::event_variation : DNP3_EVENT_BINARY_OUTPUT_STATUS_VARIATION_GROUP11_VAR2

Returns

New instance of dnp3_binary_output_status_config_t

dnp3_binary_output_status_init()

static dnp3_binary_output_status_t dnp3_binary_output_status_init ( uint16_t  index, bool  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_binary_output_status_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_binary_output_status_t

dnp3_binary_output_status_iterator_next()

dnp3_binary_output_status_t * dnp3_binary_output_status_iterator_next

(

dnp3_binary_output_status_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_broadcast_action_to_string()

static const char * dnp3_broadcast_action_to_string ( dnp3_broadcast_action_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_byte_iterator_next()

uint8_t * dnp3_byte_iterator_next

(

dnp3_byte_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_certificate_mode_to_string()

static const char * dnp3_certificate_mode_to_string ( dnp3_certificate_mode_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_class_zero_config_init()

static dnp3_class_zero_config_t dnp3_class_zero_config_init ( )

static

Initialize to default values.

Note

Values are initialized to:

• dnp3_class_zero_config_t::binary : true
• dnp3_class_zero_config_t::double_bit_binary : true
• dnp3_class_zero_config_t::binary_output_status : true
• dnp3_class_zero_config_t::counter : true
• dnp3_class_zero_config_t::frozen_counter : true
• dnp3_class_zero_config_t::analog : true
• dnp3_class_zero_config_t::analog_output_status : true
• dnp3_class_zero_config_t::octet_string : false

Returns

New instance of dnp3_class_zero_config_t

dnp3_classes_all()

static dnp3_classes_t dnp3_classes_all ( )

static

Initialize all classes to true.

Note

Values are initialized to:

• dnp3_classes_t::class0 : true
• dnp3_classes_t::class1 : true
• dnp3_classes_t::class2 : true
• dnp3_classes_t::class3 : true

Returns

New instance of dnp3_classes_t

dnp3_classes_init()

static dnp3_classes_t dnp3_classes_init ( bool  class0, bool  class1, bool  class2, bool  class3  )

static

Fully construct dnp3_classes_t specifying the value of each field.

Parameters

class0	Class 0 (static data)
class1	Class 1 events
class2	Class 2 events
class3	Class 3 events

Returns

New instance of dnp3_classes_t

dnp3_classes_none()

static dnp3_classes_t dnp3_classes_none ( )

static

Initialize all classes to false.

Note

Values are initialized to:

• dnp3_classes_t::class0 : false
• dnp3_classes_t::class1 : false
• dnp3_classes_t::class2 : false
• dnp3_classes_t::class3 : false

Returns

New instance of dnp3_classes_t

dnp3_client_state_listener_init()

static dnp3_client_state_listener_t dnp3_client_state_listener_init ( void(*)(dnp3_client_state_t, void *)  on_change, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_change	Called when the client state changed
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_client_state_to_string()

static const char * dnp3_client_state_to_string ( dnp3_client_state_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_command_error_to_string()

static const char * dnp3_command_error_to_string ( dnp3_command_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_command_mode_to_string()

static const char * dnp3_command_mode_to_string ( dnp3_command_mode_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_command_set_add_g12_v1_u16()

void dnp3_command_set_add_g12_v1_u16	(	dnp3_command_set_t *	instance,
		uint16_t	idx,
		dnp3_group12_var1_t	header
	)

Add a CROB with 2-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
header	CROB data

dnp3_command_set_add_g12_v1_u8()

void dnp3_command_set_add_g12_v1_u8	(	dnp3_command_set_t *	instance,
		uint8_t	idx,
		dnp3_group12_var1_t	header
	)

Add a CROB with 1-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
header	CROB data

dnp3_command_set_add_g41_v1_u16()

void dnp3_command_set_add_g41_v1_u16	(	dnp3_command_set_t *	instance,
		uint16_t	idx,
		int32_t	value
	)

Add a Analog Output command (signed 32-bit integer) with 2-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v1_u8()

void dnp3_command_set_add_g41_v1_u8	(	dnp3_command_set_t *	instance,
		uint8_t	idx,
		int32_t	value
	)

Add a Analog Output command (signed 32-bit integer) with 1-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v2_u16()

void dnp3_command_set_add_g41_v2_u16	(	dnp3_command_set_t *	instance,
		uint16_t	idx,
		int16_t	value
	)

Add a Analog Output command (signed 16-bit integer) with 2-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v2_u8()

void dnp3_command_set_add_g41_v2_u8	(	dnp3_command_set_t *	instance,
		uint8_t	idx,
		int16_t	value
	)

Add a Analog Output command (signed 16-bit integer) with 1-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v3_u16()

void dnp3_command_set_add_g41_v3_u16	(	dnp3_command_set_t *	instance,
		uint16_t	idx,
		float	value
	)

Add a Analog Output command (single-precision float) with 2-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v3_u8()

void dnp3_command_set_add_g41_v3_u8	(	dnp3_command_set_t *	instance,
		uint8_t	idx,
		float	value
	)

Add a Analog Output command (single-precision float) with 1-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v4_u16()

void dnp3_command_set_add_g41_v4_u16	(	dnp3_command_set_t *	instance,
		uint16_t	idx,
		double	value
	)

Add a Analog Output command (double-precision float) with 2-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_add_g41_v4_u8()

void dnp3_command_set_add_g41_v4_u8	(	dnp3_command_set_t *	instance,
		uint8_t	idx,
		double	value
	)

Add a Analog Output command (double-precision float) with 1-byte prefix index.

Parameters

instance	Instance of dnp3_command_set_t
idx	Index of the point to send the command to
value	Value to set the analog output to

dnp3_command_set_create()

dnp3_command_set_t * dnp3_command_set_create

(

)

Create a new set of commands.

Returns

Instance of dnp3_command_set_t

dnp3_command_set_destroy()

void dnp3_command_set_destroy

(

dnp3_command_set_t *

instance

)

Destroy a set of commands.

Parameters

instance

Instance of dnp3_command_set_t to destroy

dnp3_command_set_finish_header()

void dnp3_command_set_finish_header

(

dnp3_command_set_t *

instance

)

Finish any partially completed header. This allows for the construction of two headers with the same type and index.

Parameters

instance

Instance of dnp3_command_set_t

dnp3_command_status_to_string()

static const char * dnp3_command_status_to_string ( dnp3_command_status_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_command_task_callback_init()

static dnp3_command_task_callback_t dnp3_command_task_callback_init ( void(*)(dnp3_nothing_t, void *)  on_complete, void(*)(dnp3_command_error_t, void *)  on_failure, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_complete	Invoked when the asynchronous operation completes successfully
on_failure	Invoked when the asynchronous operation fails
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_configure_logging()

dnp3_param_error_t dnp3_configure_logging	(	dnp3_logging_config_t	config,
		dnp3_logger_t	logger
	)

Set the callback that will receive all the log messages.

There is only a single globally allocated logger. Calling this method a second time will return an error.

If this method is never called, no logging will be performed.

Parameters

config	Configuration options for logging
logger	Logger that will receive each logged message

Returns

Error code

dnp3_connect_strategy_init()

static dnp3_connect_strategy_t dnp3_connect_strategy_init ( )

static

Initialize to default values.

Note

Values are initialized to:

• dnp3_connect_strategy_t::min_connect_delay : 1000ms
• dnp3_connect_strategy_t::max_connect_delay : 10000ms
• dnp3_connect_strategy_t::reconnect_delay : 1000ms

Returns

New instance of dnp3_connect_strategy_t

dnp3_connection_state_listener_init()

static dnp3_connection_state_listener_t dnp3_connection_state_listener_init ( void(*)(dnp3_connection_state_t, void *)  on_change, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_change	Called when the connection state changes
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_connection_state_to_string()

static const char * dnp3_connection_state_to_string ( dnp3_connection_state_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_control_code_from_op_type()

static dnp3_control_code_t dnp3_control_code_from_op_type ( dnp3_op_type_t  op_type )

static

Initialize a dnp3_control_code_t instance from a dnp3_op_type_t.

Note

Values are initialized to:

• dnp3_control_code_t::tcc : DNP3_TRIP_CLOSE_CODE_NUL
• dnp3_control_code_t::clear : false
• dnp3_control_code_t::queue : false

Parameters

op_type

This field is used in conjunction with the dnp3_control_code_t::tcc field to specify a control operation

Returns

New instance of dnp3_control_code_t

dnp3_control_code_from_tcc_and_op_type()

static dnp3_control_code_t dnp3_control_code_from_tcc_and_op_type ( dnp3_trip_close_code_t  tcc, dnp3_op_type_t  op_type  )

static

Initialize a dnp3_control_code_t instance from a dnp3_trip_close_code_t and a dnp3_op_type_t.

Note

Values are initialized to:

• dnp3_control_code_t::clear : false
• dnp3_control_code_t::queue : false

Parameters

tcc	This field is used in conjunction with dnp3_control_code_t::op_type to specify a control operation
op_type	This field is used in conjunction with the dnp3_control_code_t::tcc field to specify a control operation

Returns

New instance of dnp3_control_code_t

dnp3_control_code_init()

static dnp3_control_code_t dnp3_control_code_init ( dnp3_trip_close_code_t  tcc, bool  clear, dnp3_op_type_t  op_type  )

static

Initialize a dnp3_control_code_t instance.

Note

Values are initialized to:

• dnp3_control_code_t::queue : false

Parameters

tcc	This field is used in conjunction with dnp3_control_code_t::op_type to specify a control operation
clear	Support for this field is optional. When the clear bit is set, the device shall remove pending control commands for that index and stop any control operation that is in progress for that index. The indexed point shall go to the state that it would have if the command were allowed to complete normally.
op_type	This field is used in conjunction with the dnp3_control_code_t::tcc field to specify a control operation

Returns

New instance of dnp3_control_code_t

dnp3_control_handler_init()

static dnp3_control_handler_t dnp3_control_handler_init ( void(*)(void *)  begin_fragment, void(*)(dnp3_database_handle_t *, void *)  end_fragment, dnp3_command_status_t(*)(dnp3_group12_var1_t, uint16_t, dnp3_database_handle_t *, void *)  select_g12v1, dnp3_command_status_t(*)(dnp3_group12_var1_t, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *)  operate_g12v1, dnp3_command_status_t(*)(int32_t, uint16_t, dnp3_database_handle_t *, void *)  select_g41v1, dnp3_command_status_t(*)(int32_t, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *)  operate_g41v1, dnp3_command_status_t(*)(int16_t, uint16_t, dnp3_database_handle_t *, void *)  select_g41v2, dnp3_command_status_t(*)(int16_t, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *)  operate_g41v2, dnp3_command_status_t(*)(float, uint16_t, dnp3_database_handle_t *, void *)  select_g41v3, dnp3_command_status_t(*)(float, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *)  operate_g41v3, dnp3_command_status_t(*)(double, uint16_t, dnp3_database_handle_t *, void *)  select_g41v4, dnp3_command_status_t(*)(double, uint16_t, dnp3_operate_type_t, dnp3_database_handle_t *, void *)  operate_g41v4, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

begin_fragment	Notifies the start of a command fragment
end_fragment	Notifies the end of a command fragment
select_g12v1	Select a CROB, but do not operate
operate_g12v1	Operate a control point
select_g41v1	Select an analog output, but do not operate
operate_g41v1	Operate a control point
select_g41v2	Select an analog output, but do not operate
operate_g41v2	Operate a control point
select_g41v3	Select an analog output, but do not operate
operate_g41v3	Operate a control point
select_g41v4	Select an analog output, but do not operate
operate_g41v4	Operate a control point
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_counter_config_init()

static dnp3_counter_config_t dnp3_counter_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_counter_config_t::static_variation : DNP3_STATIC_COUNTER_VARIATION_GROUP20_VAR1
• dnp3_counter_config_t::event_variation : DNP3_EVENT_COUNTER_VARIATION_GROUP22_VAR1
• dnp3_counter_config_t::deadband : 0

Returns

New instance of dnp3_counter_config_t

dnp3_counter_init()

static dnp3_counter_t dnp3_counter_init ( uint16_t  index, uint32_t  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_counter_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_counter_t

dnp3_counter_iterator_next()

dnp3_counter_t * dnp3_counter_iterator_next

(

dnp3_counter_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_data_bits_to_string()

static const char * dnp3_data_bits_to_string ( dnp3_data_bits_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_database_add_analog_input()

bool dnp3_database_add_analog_input	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_analog_input_config_t	config
	)

Add a new AnalogInput point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_analog_output_status()

bool dnp3_database_add_analog_output_status	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_analog_output_status_config_t	config
	)

Add a new Analog Output Status point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_binary_input()

bool dnp3_database_add_binary_input	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_binary_input_config_t	config
	)

Add a new BinaryInput point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_binary_output_status()

bool dnp3_database_add_binary_output_status	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_binary_output_status_config_t	config
	)

Add a new Binary Output Status point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_counter()

bool dnp3_database_add_counter	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_counter_config_t	config
	)

Add a new Counter point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_double_bit_binary_input()

bool dnp3_database_add_double_bit_binary_input	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_double_bit_binary_input_config_t	config
	)

Add a new Double-Bit Binary Input point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_frozen_counter()

bool dnp3_database_add_frozen_counter	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class,
		dnp3_frozen_counter_config_t	config
	)

Add a new Frozen Counter point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class
config	Configuration

Returns

True if the point was successfully added, false otherwise

dnp3_database_add_octet_string()

bool dnp3_database_add_octet_string	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_event_class_t	point_class
	)

Add a new Octet String point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point
point_class	Event class

Returns

True if the point was successfully added, false otherwise

dnp3_database_get_analog_input()

dnp3_param_error_t dnp3_database_get_analog_input	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_analog_input_t *	out
	)

Get a AnalogInput point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Analog point

Returns

Error code

dnp3_database_get_analog_output_status()

dnp3_param_error_t dnp3_database_get_analog_output_status	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_analog_output_status_t *	out
	)

Get a Analog Output Status point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Analog Output Status point

Returns

Error code

dnp3_database_get_binary_input()

dnp3_param_error_t dnp3_database_get_binary_input	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_binary_input_t *	out
	)

Get a BinaryInput point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Binary Input point

Returns

Error code

dnp3_database_get_binary_output_status()

dnp3_param_error_t dnp3_database_get_binary_output_status	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_binary_output_status_t *	out
	)

Get a Binary Output Status point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Binary Output Status point

Returns

Error code

dnp3_database_get_counter()

dnp3_param_error_t dnp3_database_get_counter	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_counter_t *	out
	)

Get a Counter point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Counter point

Returns

Error code

dnp3_database_get_double_bit_binary_input()

dnp3_param_error_t dnp3_database_get_double_bit_binary_input	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_double_bit_binary_input_t *	out
	)

Get a Double-Bit Binary Input point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Double-Bit Binary Input point

Returns

Error code

dnp3_database_get_frozen_counter()

dnp3_param_error_t dnp3_database_get_frozen_counter	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_frozen_counter_t *	out
	)

Get a Frozen Counter point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point to get
out	Frozen Counter point

Returns

Error code

dnp3_database_handle_transaction()

void dnp3_database_handle_transaction	(	dnp3_database_handle_t *	instance,
		dnp3_database_transaction_t	callback
	)

Acquire a mutex on the underlying database and apply a set of changes as a transaction.

Parameters

instance	Instance of dnp3_database_handle_t
callback	callback interface

dnp3_database_remove_analog_input()

bool dnp3_database_remove_analog_input	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove an AnalogInput point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_analog_output_status()

bool dnp3_database_remove_analog_output_status	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove an Analog Output Status point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_binary_input()

bool dnp3_database_remove_binary_input	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove a BinaryInput point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_binary_output_status()

bool dnp3_database_remove_binary_output_status	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove a Binary Output Status point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_counter()

bool dnp3_database_remove_counter	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove a Counter point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_double_bit_binary_input()

bool dnp3_database_remove_double_bit_binary_input	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove a Double-Bit Binary Input point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_frozen_counter()

bool dnp3_database_remove_frozen_counter	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove a Frozen Counter point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_remove_octet_string()

bool dnp3_database_remove_octet_string	(	dnp3_database_t *	instance,
		uint16_t	index
	)

Remove an Octet String point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the point

Returns

True if the point was successfully removed, false otherwise

dnp3_database_transaction_init()

static dnp3_database_transaction_t dnp3_database_transaction_init ( void(*)(dnp3_database_t *, void *)  execute, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

execute	Execute a transaction on the provided database
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_database_update_analog_input()

bool dnp3_database_update_analog_input	(	dnp3_database_t *	instance,
		dnp3_analog_input_t	value,
		dnp3_update_options_t	options
	)

Update a AnalogInput point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_analog_output_status()

bool dnp3_database_update_analog_output_status	(	dnp3_database_t *	instance,
		dnp3_analog_output_status_t	value,
		dnp3_update_options_t	options
	)

Update a Analog Output Status point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_binary_input()

bool dnp3_database_update_binary_input	(	dnp3_database_t *	instance,
		dnp3_binary_input_t	value,
		dnp3_update_options_t	options
	)

Update a BinaryInput point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_binary_output_status()

bool dnp3_database_update_binary_output_status	(	dnp3_database_t *	instance,
		dnp3_binary_output_status_t	value,
		dnp3_update_options_t	options
	)

Update a Binary Output Status point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_counter()

bool dnp3_database_update_counter	(	dnp3_database_t *	instance,
		dnp3_counter_t	value,
		dnp3_update_options_t	options
	)

Update a Counter point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_double_bit_binary_input()

bool dnp3_database_update_double_bit_binary_input	(	dnp3_database_t *	instance,
		dnp3_double_bit_binary_input_t	value,
		dnp3_update_options_t	options
	)

Update a Double-Bit Binary Input point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_frozen_counter()

bool dnp3_database_update_frozen_counter	(	dnp3_database_t *	instance,
		dnp3_frozen_counter_t	value,
		dnp3_update_options_t	options
	)

Update an Frozen Counter point.

Parameters

instance	Instance of dnp3_database_t
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_database_update_octet_string()

bool dnp3_database_update_octet_string	(	dnp3_database_t *	instance,
		uint16_t	index,
		dnp3_octet_string_value_t *	value,
		dnp3_update_options_t	options
	)

Update an Octet String point.

Parameters

instance	Instance of dnp3_database_t
index	Index of the octet string
value	New value of the point
options	Update options

Returns

True if the point was successfully updated, false otherwise

dnp3_decode_level_init()

static dnp3_decode_level_t dnp3_decode_level_init ( )

static

Initialize log levels to defaults.

Note

Values are initialized to:

• dnp3_decode_level_t::application : DNP3_APP_DECODE_LEVEL_NOTHING
• dnp3_decode_level_t::transport : DNP3_TRANSPORT_DECODE_LEVEL_NOTHING
• dnp3_decode_level_t::link : DNP3_LINK_DECODE_LEVEL_NOTHING
• dnp3_decode_level_t::physical : DNP3_PHYS_DECODE_LEVEL_NOTHING

Returns

New instance of dnp3_decode_level_t

dnp3_decode_level_nothing()

static dnp3_decode_level_t dnp3_decode_level_nothing ( )

static

Initialize log levels to nothing.

Note

Values are initialized to:

• dnp3_decode_level_t::application : DNP3_APP_DECODE_LEVEL_NOTHING
• dnp3_decode_level_t::transport : DNP3_TRANSPORT_DECODE_LEVEL_NOTHING
• dnp3_decode_level_t::link : DNP3_LINK_DECODE_LEVEL_NOTHING
• dnp3_decode_level_t::physical : DNP3_PHYS_DECODE_LEVEL_NOTHING

Returns

New instance of dnp3_decode_level_t

dnp3_double_bit_binary_input_config_init()

static dnp3_double_bit_binary_input_config_t dnp3_double_bit_binary_input_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_double_bit_binary_input_config_t::static_variation : DNP3_STATIC_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP3_VAR1
• dnp3_double_bit_binary_input_config_t::event_variation : DNP3_EVENT_DOUBLE_BIT_BINARY_INPUT_VARIATION_GROUP4_VAR1

Returns

New instance of dnp3_double_bit_binary_input_config_t

dnp3_double_bit_binary_input_init()

static dnp3_double_bit_binary_input_t dnp3_double_bit_binary_input_init ( uint16_t  index, dnp3_double_bit_t  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_double_bit_binary_input_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_double_bit_binary_input_t

dnp3_double_bit_binary_input_iterator_next()

dnp3_double_bit_binary_input_t * dnp3_double_bit_binary_input_iterator_next

(

dnp3_double_bit_binary_input_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_double_bit_to_string()

static const char * dnp3_double_bit_to_string ( dnp3_double_bit_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_endpoint_list_add()

void dnp3_endpoint_list_add	(	dnp3_endpoint_list_t *	instance,
		const char *	endpoint
	)

Add an IP endpoint to the list.

You can write IP addresses or DNS names and the port to connect to. e.g. "127.0.0.1:20000" or "dnp3.myorg.com:20000".

Parameters

instance	Instance of dnp3_endpoint_list_t
endpoint	Endpoint to add to the list

dnp3_endpoint_list_create()

dnp3_endpoint_list_t * dnp3_endpoint_list_create

(

const char *

main_endpoint

)

Create a new list of IP endpoints.

You can write IP addresses or DNS names and the port to connect to. e.g. "127.0.0.1:20000" or "dnp3.myorg.com:20000".

Parameters

main_endpoint

Main endpoint

Returns

Instance of dnp3_endpoint_list_t

dnp3_endpoint_list_destroy()

void dnp3_endpoint_list_destroy

(

dnp3_endpoint_list_t *

instance

)

Destroy a previously allocated endpoint list.

Parameters

instance

Instance of dnp3_endpoint_list_t to destroy

dnp3_event_analog_input_variation_to_string()

static const char * dnp3_event_analog_input_variation_to_string ( dnp3_event_analog_input_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_analog_output_status_variation_to_string()

static const char * dnp3_event_analog_output_status_variation_to_string ( dnp3_event_analog_output_status_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_binary_input_variation_to_string()

static const char * dnp3_event_binary_input_variation_to_string ( dnp3_event_binary_input_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_binary_output_status_variation_to_string()

static const char * dnp3_event_binary_output_status_variation_to_string ( dnp3_event_binary_output_status_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_buffer_config_init()

static dnp3_event_buffer_config_t dnp3_event_buffer_config_init ( uint16_t  max_binary, uint16_t  max_double_bit_binary, uint16_t  max_binary_output_status, uint16_t  max_counter, uint16_t  max_frozen_counter, uint16_t  max_analog, uint16_t  max_analog_output_status, uint16_t  max_octet_string  )

static

Fully construct dnp3_event_buffer_config_t specifying the value of each field.

Parameters

max_binary	Maximum number of Binary Input events (g2)
max_double_bit_binary	Maximum number of Double-Bit Binary Input events (g4)
max_binary_output_status	Maximum number of Binary Output Status events (g11)
max_counter	Maximum number of Counter events (g22)
max_frozen_counter	Maximum number of Frozen Counter events (g23)
max_analog	Maximum number of Analog Input events (g32)
max_analog_output_status	Maximum number of Analog Output Status events (g42)
max_octet_string	Maximum number of Octet String events (g111)

Returns

New instance of dnp3_event_buffer_config_t

dnp3_event_buffer_config_no_events()

static dnp3_event_buffer_config_t dnp3_event_buffer_config_no_events ( )

static

Create a configuration where no events are buffered.

Note

Values are initialized to:

• dnp3_event_buffer_config_t::max_binary : 0
• dnp3_event_buffer_config_t::max_double_bit_binary : 0
• dnp3_event_buffer_config_t::max_binary_output_status : 0
• dnp3_event_buffer_config_t::max_counter : 0
• dnp3_event_buffer_config_t::max_frozen_counter : 0
• dnp3_event_buffer_config_t::max_analog : 0
• dnp3_event_buffer_config_t::max_analog_output_status : 0
• dnp3_event_buffer_config_t::max_octet_string : 0

Returns

New instance of dnp3_event_buffer_config_t

dnp3_event_class_to_string()

static const char * dnp3_event_class_to_string ( dnp3_event_class_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_classes_all()

static dnp3_event_classes_t dnp3_event_classes_all ( )

static

Initialize all classes to true.

Note

Values are initialized to:

• dnp3_event_classes_t::class1 : true
• dnp3_event_classes_t::class2 : true
• dnp3_event_classes_t::class3 : true

Returns

New instance of dnp3_event_classes_t

dnp3_event_classes_init()

static dnp3_event_classes_t dnp3_event_classes_init ( bool  class1, bool  class2, bool  class3  )

static

Fully construct dnp3_event_classes_t specifying the value of each field.

Parameters

class1	Class 1 events
class2	Class 2 events
class3	Class 3 events

Returns

New instance of dnp3_event_classes_t

dnp3_event_classes_none()

static dnp3_event_classes_t dnp3_event_classes_none ( )

static

Initialize all classes to false.

Note

Values are initialized to:

• dnp3_event_classes_t::class1 : false
• dnp3_event_classes_t::class2 : false
• dnp3_event_classes_t::class3 : false

Returns

New instance of dnp3_event_classes_t

dnp3_event_counter_variation_to_string()

static const char * dnp3_event_counter_variation_to_string ( dnp3_event_counter_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_double_bit_binary_input_variation_to_string()

static const char * dnp3_event_double_bit_binary_input_variation_to_string ( dnp3_event_double_bit_binary_input_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_frozen_counter_variation_to_string()

static const char * dnp3_event_frozen_counter_variation_to_string ( dnp3_event_frozen_counter_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_event_mode_to_string()

static const char * dnp3_event_mode_to_string ( dnp3_event_mode_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_flags_init()

static dnp3_flags_t dnp3_flags_init ( uint8_t  value )

static

Fully construct dnp3_flags_t specifying the value of each field.

Parameters

value

bit-mask representing a set of individual flag bits

Returns

New instance of dnp3_flags_t

dnp3_flow_control_to_string()

static const char * dnp3_flow_control_to_string ( dnp3_flow_control_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_freeze_result_to_string()

static const char * dnp3_freeze_result_to_string ( dnp3_freeze_result_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_freeze_type_to_string()

static const char * dnp3_freeze_type_to_string ( dnp3_freeze_type_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_frozen_counter_config_init()

static dnp3_frozen_counter_config_t dnp3_frozen_counter_config_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_frozen_counter_config_t::static_variation : DNP3_STATIC_FROZEN_COUNTER_VARIATION_GROUP21_VAR1
• dnp3_frozen_counter_config_t::event_variation : DNP3_EVENT_FROZEN_COUNTER_VARIATION_GROUP23_VAR1
• dnp3_frozen_counter_config_t::deadband : 0

Returns

New instance of dnp3_frozen_counter_config_t

dnp3_frozen_counter_init()

static dnp3_frozen_counter_t dnp3_frozen_counter_init ( uint16_t  index, uint32_t  value, dnp3_flags_t  flags, dnp3_timestamp_t  time  )

static

Fully construct dnp3_frozen_counter_t specifying the value of each field.

Parameters

index	Point index
value	Point value
flags	Point flags
time	Point timestamp

Returns

New instance of dnp3_frozen_counter_t

dnp3_frozen_counter_iterator_next()

dnp3_frozen_counter_t * dnp3_frozen_counter_iterator_next

(

dnp3_frozen_counter_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_function_code_to_string()

static const char * dnp3_function_code_to_string ( dnp3_function_code_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_group12_var1_from_code()

static dnp3_group12_var1_t dnp3_group12_var1_from_code ( dnp3_control_code_t  code )

static

Construct a dnp3_group12_var1_t from a dnp3_control_code_t.

Note

Values are initialized to:

• dnp3_group12_var1_t::count : 1
• dnp3_group12_var1_t::on_time : 1000
• dnp3_group12_var1_t::off_time : 1000

Parameters

code	Control code

Returns

New instance of dnp3_group12_var1_t

dnp3_group12_var1_init()

static dnp3_group12_var1_t dnp3_group12_var1_init ( dnp3_control_code_t  code, uint8_t  count, uint32_t  on_time, uint32_t  off_time  )

static

Fully construct dnp3_group12_var1_t specifying the value of each field.

Parameters

code	Control code
count	Count
on_time	Duration the output drive remains active (in milliseconds)
off_time	Duration the output drive remains non-active (in milliseconds)

Returns

New instance of dnp3_group12_var1_t

dnp3_link_decode_level_to_string()

static const char * dnp3_link_decode_level_to_string ( dnp3_link_decode_level_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_link_error_mode_to_string()

static const char * dnp3_link_error_mode_to_string ( dnp3_link_error_mode_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_link_status_callback_init()

static dnp3_link_status_callback_t dnp3_link_status_callback_init ( void(*)(dnp3_nothing_t, void *)  on_complete, void(*)(dnp3_link_status_error_t, void *)  on_failure, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_complete	Invoked when the asynchronous operation completes successfully
on_failure	Invoked when the asynchronous operation fails
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_link_status_error_to_string()

static const char * dnp3_link_status_error_to_string ( dnp3_link_status_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_log_level_to_string()

static const char * dnp3_log_level_to_string ( dnp3_log_level_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_log_output_format_to_string()

static const char * dnp3_log_output_format_to_string ( dnp3_log_output_format_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_logger_init()

static dnp3_logger_t dnp3_logger_init ( void(*)(dnp3_log_level_t, const char *, void *)  on_message, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_message	Called when a log message was received and should be logged
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_logging_config_init()

static dnp3_logging_config_t dnp3_logging_config_init ( )

static

Initialize the configuration to default values.

Note

Values are initialized to:

• dnp3_logging_config_t::level : DNP3_LOG_LEVEL_INFO
• dnp3_logging_config_t::output_format : DNP3_LOG_OUTPUT_FORMAT_TEXT
• dnp3_logging_config_t::time_format : DNP3_TIME_FORMAT_SYSTEM
• dnp3_logging_config_t::print_level : true
• dnp3_logging_config_t::print_module_info : false

Returns

New instance of dnp3_logging_config_t

dnp3_master_channel_add_association()

dnp3_param_error_t dnp3_master_channel_add_association	(	dnp3_master_channel_t *	instance,
		uint16_t	address,
		dnp3_association_config_t	config,
		dnp3_read_handler_t	read_handler,
		dnp3_association_handler_t	association_handler,
		dnp3_association_information_t	association_information,
		dnp3_association_id_t *	out
	)

Add an association to the channel.

Parameters

instance	Instance of dnp3_master_channel_t
address	DNP3 data-link address of the remote outstation
config	Association configuration
read_handler	Interface uses to load measurement data
association_handler	Association specific callbacks such as time synchronization
association_information	Association information interface
out	Id of the association

Returns

Error code

dnp3_master_channel_add_poll()

dnp3_param_error_t dnp3_master_channel_add_poll	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	id,
		dnp3_request_t *	request,
		uint64_t	period,
		dnp3_poll_id_t *	out
	)

Add a periodic poll to an association.

Each result of the poll will be sent to the dnp3_read_handler_t of the association.

Parameters

instance	Instance of dnp3_master_channel_t
id	Association on which to add the poll
request	Request to perform
period	Period to wait between each poll (in ms) (milliseconds)
out	Id of the created poll

Returns

Error code

dnp3_master_channel_check_link_status()

dnp3_param_error_t dnp3_master_channel_check_link_status	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_link_status_callback_t	callback
	)

Asynchronously perform a link status check.

Parameters

instance	Instance of dnp3_master_channel_t
association	Id of the association
callback	callback invoked when the operation completes

Returns

Error code

dnp3_master_channel_cold_restart()

dnp3_param_error_t dnp3_master_channel_cold_restart	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_restart_task_callback_t	callback
	)

Asynchronously perform a cold restart operation to the association.

Parameters

instance	Instance of dnp3_master_channel_t
association	Id of the association
callback	callback invoked when the operation completes

Returns

Error code

dnp3_master_channel_config_init()

static dnp3_master_channel_config_t dnp3_master_channel_config_init ( uint16_t  address )

static

Initialize dnp3_master_channel_config_t to default values.

Note

Values are initialized to:

• dnp3_master_channel_config_t::decode_level : Default dnp3_decode_level_t
• dnp3_master_channel_config_t::tx_buffer_size : 2048
• dnp3_master_channel_config_t::rx_buffer_size : 2048

Parameters

address

Local DNP3 data-link address

Returns

New instance of dnp3_master_channel_config_t

dnp3_master_channel_create_serial()

dnp3_param_error_t dnp3_master_channel_create_serial	(	dnp3_runtime_t *	runtime,
		dnp3_master_channel_config_t	config,
		const char *	path,
		dnp3_serial_settings_t	serial_params,
		uint64_t	open_retry_delay,
		dnp3_port_state_listener_t	listener,
		dnp3_master_channel_t **	out
	)

Create a master channel on the specified serial port.

The returned master must be gracefully shutdown with dnp3_master_channel_destroy when done.

Parameters

runtime	Runtime to use to drive asynchronous operations of the master
config	Generic configuration for the channel
path	Path to the serial device. Generally /dev/tty0 on Linux and COM1 on Windows.
serial_params	Serial port settings
open_retry_delay	delay between attempts to open the serial port (milliseconds)
listener	Listener to receive updates on the status of the serial port
out	Handle to the master created, NULL if an error occurred

Returns

Error code

dnp3_master_channel_create_tcp()

dnp3_param_error_t dnp3_master_channel_create_tcp	(	dnp3_runtime_t *	runtime,
		dnp3_link_error_mode_t	link_error_mode,
		dnp3_master_channel_config_t	config,
		dnp3_endpoint_list_t *	endpoints,
		dnp3_connect_strategy_t	connect_strategy,
		dnp3_client_state_listener_t	listener,
		dnp3_master_channel_t **	out
	)

Create a master channel that connects to the specified TCP endpoint(s)

Parameters

runtime	Runtime to use to drive asynchronous operations of the master
link_error_mode	Controls how link errors are handled with respect to the TCP session
config	Generic configuration for the channel
endpoints	List of IP endpoints.
connect_strategy	Controls the timing of (re)connection attempts
listener	TCP connection listener used to receive updates on the status of the connection
out	Handle to the master created, NULL if an error occurred

Returns

Error code

dnp3_master_channel_create_tls()

dnp3_param_error_t dnp3_master_channel_create_tls	(	dnp3_runtime_t *	runtime,
		dnp3_link_error_mode_t	link_error_mode,
		dnp3_master_channel_config_t	config,
		dnp3_endpoint_list_t *	endpoints,
		dnp3_connect_strategy_t	connect_strategy,
		dnp3_client_state_listener_t	listener,
		dnp3_tls_client_config_t	tls_config,
		dnp3_master_channel_t **	out
	)

Create a master channel that connects to the specified TCP endpoint(s) and establish a TLS session with the remote.

Parameters

runtime	Runtime to use to drive asynchronous operations of the master
link_error_mode	Controls how link errors are handled with respect to the TCP session
config	Generic configuration for the channel
endpoints	List of IP endpoints.
connect_strategy	Controls the timing of (re)connection attempts
listener	TCP connection listener used to receive updates on the status of the connection
tls_config	TLS client configuration
out	Handle to the master created, NULL if an error occurred

Returns

Error code

dnp3_master_channel_demand_poll()

dnp3_param_error_t dnp3_master_channel_demand_poll	(	dnp3_master_channel_t *	instance,
		dnp3_poll_id_t	poll_id
	)

Demand the immediate execution of a poll previously created with dnp3_master_channel_add_poll.

This method returns immediately. The result will be sent to the registered dnp3_read_handler_t.

This method resets the internal timer of the poll.

Parameters

instance	Instance of dnp3_master_channel_t
poll_id	Id of the poll

Returns

Error code

dnp3_master_channel_destroy()

void dnp3_master_channel_destroy

(

dnp3_master_channel_t *

instance

)

Shutdown a dnp3_master_channel_t and release all resources.

Parameters

instance

Instance of dnp3_master_channel_t to destroy

dnp3_master_channel_disable()

dnp3_param_error_t dnp3_master_channel_disable

(

dnp3_master_channel_t *

instance

)

stop communications

Parameters

instance

Instance of dnp3_master_channel_t

Returns

Error code

dnp3_master_channel_enable()

dnp3_param_error_t dnp3_master_channel_enable

(

dnp3_master_channel_t *

instance

)

start communications

Parameters

instance

Instance of dnp3_master_channel_t

Returns

Error code

dnp3_master_channel_get_decode_level()

dnp3_param_error_t dnp3_master_channel_get_decode_level	(	dnp3_master_channel_t *	instance,
		dnp3_decode_level_t *	out
	)

Get the decoding level for the channel.

Parameters

instance	Instance of dnp3_master_channel_t
out	Decode level

Returns

Error code

dnp3_master_channel_operate()

dnp3_param_error_t dnp3_master_channel_operate	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_command_mode_t	mode,
		dnp3_command_set_t *	command,
		dnp3_command_task_callback_t	callback
	)

Asynchronously perform a command operation on the association.

Parameters

instance	Instance of dnp3_master_channel_t
association	Id of the association
mode	Operation mode
command	Command to send
callback	callback invoked when the operation completes

Returns

Error code

dnp3_master_channel_read()

dnp3_param_error_t dnp3_master_channel_read	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_request_t *	request,
		dnp3_read_task_callback_t	callback
	)

Perform a read on the association.

The callback will be called once the read is completely received, but the actual values will be sent to the dnp3_read_handler_t of the association.

Parameters

instance	Instance of dnp3_master_channel_t
association	Association on which to perform the read
request	Request to send
callback	callback invoked when the operation completes

Returns

Error code

dnp3_master_channel_read_with_handler()

dnp3_param_error_t dnp3_master_channel_read_with_handler	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_request_t *	request,
		dnp3_read_handler_t	handler,
		dnp3_read_task_callback_t	callback
	)

Perform a read on the association.

The callback will be called once the read is completely received, but the actual values will be sent to the dnp3_read_handler_t passed as a parameter.

Parameters

instance	Instance of dnp3_master_channel_t
association	Association on which to perform the read
request	Request to send
handler	Custom dnp3_read_handler_t to send the data to
callback	callback invoked when the operation completes

Returns

Error code

dnp3_master_channel_remove_association()

dnp3_param_error_t dnp3_master_channel_remove_association	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	id
	)

Remove an association from the channel.

Parameters

instance	Instance of dnp3_master_channel_t
id	Id of the association

Returns

Error code

dnp3_master_channel_remove_poll()

dnp3_param_error_t dnp3_master_channel_remove_poll	(	dnp3_master_channel_t *	instance,
		dnp3_poll_id_t	poll_id
	)

Add a periodic poll to an association.

Each result of the poll will be sent to the dnp3_read_handler_t of the association.

Parameters

instance	Instance of dnp3_master_channel_t
poll_id	Id of the created poll

Returns

Error code

dnp3_master_channel_set_decode_level()

dnp3_param_error_t dnp3_master_channel_set_decode_level	(	dnp3_master_channel_t *	instance,
		dnp3_decode_level_t	decode_level
	)

Set the decoding level for the channel.

Parameters

instance	Instance of dnp3_master_channel_t
decode_level	Decoding level

Returns

Error code

dnp3_master_channel_synchronize_time()

dnp3_param_error_t dnp3_master_channel_synchronize_time	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_time_sync_mode_t	mode,
		dnp3_time_sync_task_callback_t	callback
	)

Asynchronously perform a time sync operation to the association.

Parameters

instance	Instance of dnp3_master_channel_t
association	Id of the association
mode	Time sync mode
callback	callback invoked when the operation completes

Returns

Error code

dnp3_master_channel_warm_restart()

dnp3_param_error_t dnp3_master_channel_warm_restart	(	dnp3_master_channel_t *	instance,
		dnp3_association_id_t	association,
		dnp3_restart_task_callback_t	callback
	)

Asynchronously perform a warm restart operation to the association.

Parameters

instance	Instance of dnp3_master_channel_t
association	Id of the association
callback	callback invoked when the operation completes

Returns

Error code

dnp3_min_tls_version_to_string()

static const char * dnp3_min_tls_version_to_string ( dnp3_min_tls_version_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_nothing_to_string()

static const char * dnp3_nothing_to_string ( dnp3_nothing_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_octet_string_iterator_next()

dnp3_octet_string_t * dnp3_octet_string_iterator_next

(

dnp3_octet_string_iterator_t *

iter

)

returns a pointer to the next value or NULL

Parameters

iter	opaque iterator on which to retrieve the next value

Returns

next value or NULL

dnp3_octet_string_value_add()

void dnp3_octet_string_value_add	(	dnp3_octet_string_value_t *	instance,
		uint8_t	value
	)

Add a value to the collection.

Parameters

instance	instance to which to add the value
value	value to add to the instance

dnp3_octet_string_value_create()

dnp3_octet_string_value_t * dnp3_octet_string_value_create

(

)

Creates an instance of the collection.

Returns

Allocated opaque collection instance

dnp3_octet_string_value_destroy()

void dnp3_octet_string_value_destroy

(

dnp3_octet_string_value_t *

instance

)

Destroys an instance of the collection.

Parameters

instance

instance to destroy

dnp3_op_type_to_string()

static const char * dnp3_op_type_to_string ( dnp3_op_type_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_operate_type_to_string()

static const char * dnp3_operate_type_to_string ( dnp3_operate_type_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_outstation_application_init()

static dnp3_outstation_application_t dnp3_outstation_application_init ( uint16_t(*)(void *)  get_processing_delay_ms, dnp3_write_time_result_t(*)(uint64_t, void *)  write_absolute_time, dnp3_application_iin_t(*)(void *)  get_application_iin, dnp3_restart_delay_t(*)(void *)  cold_restart, dnp3_restart_delay_t(*)(void *)  warm_restart, dnp3_freeze_result_t(*)(dnp3_freeze_type_t, dnp3_database_handle_t *, void *)  freeze_counters_all, dnp3_freeze_result_t(*)(uint16_t, uint16_t, dnp3_freeze_type_t, dnp3_database_handle_t *, void *)  freeze_counters_range, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

get_processing_delay_ms	Returns the DELAY_MEASUREMENT delay
write_absolute_time	Handle a write of the absolute time during time synchronization procedures.
get_application_iin	Returns the application-controlled IIN bits
cold_restart	Request that the outstation perform a cold restart (IEEE-1815 2012, p. 58)
warm_restart	Request that the outstation perform a warm restart (IEEE-1815 2012, p. 58)
freeze_counters_all	Freeze all the counters
freeze_counters_range	Freeze a range of counters
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_outstation_config_init()

static dnp3_outstation_config_t dnp3_outstation_config_init ( uint16_t  outstation_address, uint16_t  master_address, dnp3_event_buffer_config_t  event_buffer_config  )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_outstation_config_t::solicited_buffer_size : 2048
• dnp3_outstation_config_t::unsolicited_buffer_size : 2048
• dnp3_outstation_config_t::rx_buffer_size : 2048
• dnp3_outstation_config_t::decode_level : Default dnp3_decode_level_t
• dnp3_outstation_config_t::confirm_timeout : 5000ms
• dnp3_outstation_config_t::select_timeout : 5000ms
• dnp3_outstation_config_t::features : Default dnp3_outstation_features_t
• dnp3_outstation_config_t::max_unsolicited_retries : 4294967295
• dnp3_outstation_config_t::unsolicited_retry_delay : 5000ms
• dnp3_outstation_config_t::keep_alive_timeout : 60000ms
• dnp3_outstation_config_t::max_read_request_headers : 64
• dnp3_outstation_config_t::max_controls_per_request : 65535
• dnp3_outstation_config_t::class_zero : Default dnp3_class_zero_config_t

Parameters

outstation_address	Link-layer outstation address
master_address	Link-layer master address
event_buffer_config	Event buffer sizes configuration

Returns

New instance of dnp3_outstation_config_t

dnp3_outstation_create_serial_session()

dnp3_param_error_t dnp3_outstation_create_serial_session	(	dnp3_runtime_t *	runtime,
		const char *	serial_path,
		dnp3_serial_settings_t	settings,
		dnp3_outstation_config_t	config,
		dnp3_outstation_application_t	application,
		dnp3_outstation_information_t	information,
		dnp3_control_handler_t	control_handler,
		dnp3_outstation_t **	out
	)

Create an outstation instance running on a serial port.

The port is opened immediately on the calling thread and fails if not successful

Warning

Most users should prefer the fault tolerant version of the this method dnp3_outstation_create_serial_session_fault_tolerant

Parameters

runtime	runtime on which to spawn the outstation
serial_path	Path of the serial device
settings	settings for the serial port
config	outstation configuration
application	application interface
information	informational events interface
control_handler	control handler interface
out	Outstation instance or NULL if the port cannot be opened

Returns

Error code

dnp3_outstation_create_serial_session_fault_tolerant()

dnp3_param_error_t dnp3_outstation_create_serial_session_fault_tolerant	(	dnp3_runtime_t *	runtime,
		const char *	serial_path,
		dnp3_serial_settings_t	settings,
		uint64_t	open_retry_delay,
		dnp3_outstation_config_t	config,
		dnp3_outstation_application_t	application,
		dnp3_outstation_information_t	information,
		dnp3_control_handler_t	control_handler,
		dnp3_outstation_t **	out
	)

Create an outstation instance running on a serial port which is tolerant to the serial port being added and removed.

Parameters

runtime	runtime on which to spawn the outstation
serial_path	Path of the serial device
settings	settings for the serial port
open_retry_delay	delay between attempts to open the serial port (milliseconds)
config	outstation configuration
application	application interface
information	informational events interface
control_handler	control handler interface
out	Outstation instance or NULL if the port cannot be opened

Returns

Error code

dnp3_outstation_destroy()

void dnp3_outstation_destroy

(

dnp3_outstation_t *

instance

)

Free resources of the outstation.

Warning

This does not shutdown the outstation. Only dnp3_outstation_server_destroy will properly shutdown the outstation.

Parameters

instance

Instance of dnp3_outstation_t to destroy

dnp3_outstation_features_init()

static dnp3_outstation_features_t dnp3_outstation_features_init ( )

static

Initialize to default values.

Note

Values are initialized to:

• dnp3_outstation_features_t::self_address : false
• dnp3_outstation_features_t::broadcast : true
• dnp3_outstation_features_t::unsolicited : true

Returns

New instance of dnp3_outstation_features_t

dnp3_outstation_information_init()

static dnp3_outstation_information_t dnp3_outstation_information_init ( void(*)(dnp3_request_header_t, void *)  process_request_from_idle, void(*)(dnp3_function_code_t, dnp3_broadcast_action_t, void *)  broadcast_received, void(*)(uint8_t, void *)  enter_solicited_confirm_wait, void(*)(uint8_t, void *)  solicited_confirm_timeout, void(*)(uint8_t, void *)  solicited_confirm_received, void(*)(void *)  solicited_confirm_wait_new_request, void(*)(uint8_t, uint8_t, void *)  wrong_solicited_confirm_seq, void(*)(bool, uint8_t, void *)  unexpected_confirm, void(*)(uint8_t, void *)  enter_unsolicited_confirm_wait, void(*)(uint8_t, bool, void *)  unsolicited_confirm_timeout, void(*)(uint8_t, void *)  unsolicited_confirmed, void(*)(void *)  clear_restart_iin, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

process_request_from_idle	Called when a request is processed from the IDLE state
broadcast_received	Called when a broadcast request is received by the outstation
enter_solicited_confirm_wait	Outstation has begun waiting for a solicited confirm
solicited_confirm_timeout	Failed to receive a solicited confirm before the timeout occurred
solicited_confirm_received	Received the expected confirm
solicited_confirm_wait_new_request	Received a new request while waiting for a solicited confirm, aborting the response series
wrong_solicited_confirm_seq	Received a solicited confirm with the wrong sequence number
unexpected_confirm	Received a confirm when not expecting one
enter_unsolicited_confirm_wait	Outstation has begun waiting for an unsolicited confirm
unsolicited_confirm_timeout	Failed to receive an unsolicited confirm before the timeout occurred
unsolicited_confirmed	Master confirmed an unsolicited message
clear_restart_iin	Master cleared the restart IIN bit
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_outstation_server_add_outstation()

dnp3_param_error_t dnp3_outstation_server_add_outstation	(	dnp3_outstation_server_t *	instance,
		dnp3_outstation_config_t	config,
		dnp3_outstation_application_t	application,
		dnp3_outstation_information_t	information,
		dnp3_control_handler_t	control_handler,
		dnp3_connection_state_listener_t	listener,
		dnp3_address_filter_t *	filter,
		dnp3_outstation_t **	out
	)

Add an outstation to the server.

The returned dnp3_outstation_t can be used to modify points of the outstation.

In order for the outstation to run, the TCP server must be running. Use dnp3_outstation_server_bind to run it.

Parameters

instance	Instance of dnp3_outstation_server_t
config	Outstation configuration
application	Outstation application callbacks
information	Outstation information callbacks
control_handler	Outstation control handler
listener	Listener for the connection state
filter	Address filter
out	Outstation handle

Returns

Error code

dnp3_outstation_server_bind()

dnp3_param_error_t dnp3_outstation_server_bind

(

dnp3_outstation_server_t *

instance

)

Bind the server to the port and starts listening. Also starts all the outstations associated to it.

Parameters

instance

Instance of dnp3_outstation_server_t

Returns

Error code

dnp3_outstation_server_create_tcp_server()

dnp3_param_error_t dnp3_outstation_server_create_tcp_server	(	dnp3_runtime_t *	runtime,
		dnp3_link_error_mode_t	link_error_mode,
		const char *	address,
		dnp3_outstation_server_t **	out
	)

Create a new TCP server.

To start it, use dnp3_outstation_server_bind.

Parameters

runtime	Runtime to execute the server on
link_error_mode	Controls how link errors are handled with respect to the TCP session
address	Address to bind the server to e.g. 127.0.0.1:20000
out	New TCP server instance

Returns

Error code

dnp3_outstation_server_create_tls_server()

dnp3_param_error_t dnp3_outstation_server_create_tls_server	(	dnp3_runtime_t *	runtime,
		dnp3_link_error_mode_t	link_error_mode,
		const char *	address,
		dnp3_tls_server_config_t	tls_config,
		dnp3_outstation_server_t **	out
	)

Create a new TLS server.

To start it, use dnp3_outstation_server_bind.

Parameters

runtime	Runtime to execute the server on
link_error_mode	Controls how link errors are handled with respect to the session
address	Address to bind the server to e.g. 127.0.0.1:20000
tls_config	TLS server configuration
out	New TLS server instance

Returns

Error code

dnp3_outstation_server_destroy()

void dnp3_outstation_server_destroy

(

dnp3_outstation_server_t *

instance

)

Gracefully shutdown all the outstations associated to this server, stops the server and release resources.

Parameters

instance

Instance of dnp3_outstation_server_t to destroy

dnp3_outstation_set_decode_level()

dnp3_param_error_t dnp3_outstation_set_decode_level	(	dnp3_outstation_t *	instance,
		dnp3_decode_level_t	level
	)

Set decoding log level.

Parameters

instance	Instance of dnp3_outstation_t
level	Decode log

Returns

Error code

dnp3_outstation_transaction()

void dnp3_outstation_transaction	(	dnp3_outstation_t *	instance,
		dnp3_database_transaction_t	callback
	)

Acquire a mutex on the underlying database and apply a set of changes as a transaction.

Parameters

instance	Instance of dnp3_outstation_t
callback	Interface on which to execute the transaction

dnp3_param_error_to_string()

static const char * dnp3_param_error_to_string ( dnp3_param_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_parity_to_string()

static const char * dnp3_parity_to_string ( dnp3_parity_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_phys_decode_level_to_string()

static const char * dnp3_phys_decode_level_to_string ( dnp3_phys_decode_level_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_port_state_listener_init()

static dnp3_port_state_listener_t dnp3_port_state_listener_init ( void(*)(dnp3_port_state_t, void *)  on_change, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_change	Invoked when the serial port changes state
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_port_state_to_string()

static const char * dnp3_port_state_to_string ( dnp3_port_state_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_qualifier_code_to_string()

static const char * dnp3_qualifier_code_to_string ( dnp3_qualifier_code_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_read_error_to_string()

static const char * dnp3_read_error_to_string ( dnp3_read_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_read_handler_init()

static dnp3_read_handler_t dnp3_read_handler_init ( void(*)(dnp3_read_type_t, dnp3_response_header_t, void *)  begin_fragment, void(*)(dnp3_read_type_t, dnp3_response_header_t, void *)  end_fragment, void(*)(dnp3_header_info_t, dnp3_binary_input_iterator_t *, void *)  handle_binary_input, void(*)(dnp3_header_info_t, dnp3_double_bit_binary_input_iterator_t *, void *)  handle_double_bit_binary_input, void(*)(dnp3_header_info_t, dnp3_binary_output_status_iterator_t *, void *)  handle_binary_output_status, void(*)(dnp3_header_info_t, dnp3_counter_iterator_t *, void *)  handle_counter, void(*)(dnp3_header_info_t, dnp3_frozen_counter_iterator_t *, void *)  handle_frozen_counter, void(*)(dnp3_header_info_t, dnp3_analog_input_iterator_t *, void *)  handle_analog_input, void(*)(dnp3_header_info_t, dnp3_analog_output_status_iterator_t *, void *)  handle_analog_output_status, void(*)(dnp3_header_info_t, dnp3_octet_string_iterator_t *, void *)  handle_octet_string, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

begin_fragment	Marks the beginning of a fragment
end_fragment	Marks the end of a fragment
handle_binary_input	Handle binary input data
handle_double_bit_binary_input	Handle double-bit binary input data
handle_binary_output_status	Handle binary output status data
handle_counter	Handle counter data
handle_frozen_counter	Handle frozen counter input data
handle_analog_input	Handle analog input data
handle_analog_output_status	Handle analog output status data
handle_octet_string	Handle octet string data
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_read_task_callback_init()

static dnp3_read_task_callback_t dnp3_read_task_callback_init ( void(*)(dnp3_nothing_t, void *)  on_complete, void(*)(dnp3_read_error_t, void *)  on_failure, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_complete	Invoked when the asynchronous operation completes successfully
on_failure	Invoked when the asynchronous operation fails
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_read_type_to_string()

static const char * dnp3_read_type_to_string ( dnp3_read_type_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_request_add_all_objects_header()

void dnp3_request_add_all_objects_header	(	dnp3_request_t *	instance,
		dnp3_variation_t	variation
	)

Add an all objects variation interrogation.

Parameters

instance	Instance of dnp3_request_t
variation	Variation to ask for

dnp3_request_add_one_byte_limited_count_header()

void dnp3_request_add_one_byte_limited_count_header	(	dnp3_request_t *	instance,
		dnp3_variation_t	variation,
		uint8_t	count
	)

Add a one-byte limited count variation interrogation.

Parameters

instance	Instance of dnp3_request_t
variation	Variation to ask for
count	Maximum number of events

dnp3_request_add_one_byte_range_header()

void dnp3_request_add_one_byte_range_header	(	dnp3_request_t *	instance,
		dnp3_variation_t	variation,
		uint8_t	start,
		uint8_t	stop
	)

Add a one-byte start/stop variation interrogation.

Parameters

instance	Instance of dnp3_request_t
variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

dnp3_request_add_two_byte_limited_count_header()

void dnp3_request_add_two_byte_limited_count_header	(	dnp3_request_t *	instance,
		dnp3_variation_t	variation,
		uint16_t	count
	)

Add a two-byte limited count variation interrogation.

Parameters

instance	Instance of dnp3_request_t
variation	Variation to ask for
count	Maximum number of events

dnp3_request_add_two_byte_range_header()

void dnp3_request_add_two_byte_range_header	(	dnp3_request_t *	instance,
		dnp3_variation_t	variation,
		uint16_t	start,
		uint16_t	stop
	)

Add a two-byte start/stop variation interrogation.

Parameters

instance	Instance of dnp3_request_t
variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

dnp3_request_create()

dnp3_request_t * dnp3_request_create

(

)

Create a new request.

Returns

Instance of dnp3_request_t

dnp3_request_destroy()

void dnp3_request_destroy

(

dnp3_request_t *

instance

)

Destroy a request created with dnp3_request_create or dnp3_request_class_request.

Parameters

instance

Instance of dnp3_request_t to destroy

dnp3_request_new_all_objects()

dnp3_request_t * dnp3_request_new_all_objects

(

dnp3_variation_t

variation

)

Create a new request asking for all objects of a particular variation.

An identical request can be created manually with dnp3_request_create and dnp3_request_add_all_objects_header.

Parameters

variation

Variation to ask for

Returns

Handle to the created request

dnp3_request_new_class()

dnp3_request_t * dnp3_request_new_class	(	bool	class0,
		bool	class1,
		bool	class2,
		bool	class3
	)

Create a new request asking for classes.

An identical request can be created manually with dnp3_request_add_all_objects_header and variations DNP3_VARIATION_GROUP60_VAR1, DNP3_VARIATION_GROUP60_VAR2, DNP3_VARIATION_GROUP60_VAR3 and DNP3_VARIATION_GROUP60_VAR4.

Parameters

class0	Ask for class 0 (static data)
class1	Ask for class 1 events
class2	Ask for class 2 events
class3	Ask for class 3 events

Returns

Handle to the created request

dnp3_request_new_one_byte_limited_count()

dnp3_request_t * dnp3_request_new_one_byte_limited_count	(	dnp3_variation_t	variation,
		uint8_t	count
	)

Create a new request asking for a limited count of objects (using 8-bit start/stop).

An identical request can be created manually with dnp3_request_create and dnp3_request_add_one_byte_limited_count_header.

Parameters

variation	Variation to ask for
count	Maximum number of events

Returns

Handle to the created request

dnp3_request_new_one_byte_range()

dnp3_request_t * dnp3_request_new_one_byte_range	(	dnp3_variation_t	variation,
		uint8_t	start,
		uint8_t	stop
	)

Create a new request asking for range of objects (using 8-bit start/stop).

An identical request can be created manually with dnp3_request_create and dnp3_request_add_one_byte_range_header.

Parameters

variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

Returns

Handle to the created request

dnp3_request_new_two_byte_limited_count()

dnp3_request_t * dnp3_request_new_two_byte_limited_count	(	dnp3_variation_t	variation,
		uint16_t	count
	)

Create a new request asking for a limited count of objects (using 16-bit start/stop).

An identical request can be created manually with dnp3_request_create and dnp3_request_add_two_byte_limited_count_header.

Parameters

variation	Variation to ask for
count	Maximum number of events

Returns

Handle to the created request

dnp3_request_new_two_byte_range()

dnp3_request_t * dnp3_request_new_two_byte_range	(	dnp3_variation_t	variation,
		uint16_t	start,
		uint16_t	stop
	)

Create a new request asking for range of objects (using 16-bit start/stop).

An identical request can be created manually with dnp3_request_create and dnp3_request_add_two_byte_range_header.

Parameters

variation	Variation to ask for
start	Start index to ask
stop	Stop index to ask (inclusive)

Returns

Handle to the created request

dnp3_response_function_to_string()

static const char * dnp3_response_function_to_string ( dnp3_response_function_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_restart_delay_milliseconds()

static dnp3_restart_delay_t dnp3_restart_delay_milliseconds ( uint16_t  value )

static

RestartDelay with a count of milliseconds.

Note

Values are initialized to:

• dnp3_restart_delay_t::restart_type : DNP3_RESTART_DELAY_TYPE_MILLI_SECONDS

Parameters

value

Expected delay before the outstation comes back online.

Returns

New instance of dnp3_restart_delay_t

dnp3_restart_delay_not_supported()

static dnp3_restart_delay_t dnp3_restart_delay_not_supported ( )

static

RestartDelay indicating that the request is not supported.

Note

Values are initialized to:

• dnp3_restart_delay_t::restart_type : DNP3_RESTART_DELAY_TYPE_NOT_SUPPORTED
• dnp3_restart_delay_t::value : 0

Returns

New instance of dnp3_restart_delay_t

dnp3_restart_delay_seconds()

static dnp3_restart_delay_t dnp3_restart_delay_seconds ( uint16_t  value )

static

RestartDelay with a count of seconds.

Note

Values are initialized to:

• dnp3_restart_delay_t::restart_type : DNP3_RESTART_DELAY_TYPE_SECONDS

Parameters

value

Expected delay before the outstation comes back online.

Returns

New instance of dnp3_restart_delay_t

dnp3_restart_delay_type_to_string()

static const char * dnp3_restart_delay_type_to_string ( dnp3_restart_delay_type_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_restart_error_to_string()

static const char * dnp3_restart_error_to_string ( dnp3_restart_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_restart_task_callback_init()

static dnp3_restart_task_callback_t dnp3_restart_task_callback_init ( void(*)(uint64_t, void *)  on_complete, void(*)(dnp3_restart_error_t, void *)  on_failure, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_complete	Invoked when the asynchronous operation completes successfully
on_failure	Invoked when the asynchronous operation fails
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_retry_strategy_init()

static dnp3_retry_strategy_t dnp3_retry_strategy_init ( )

static

Initialize to defaults.

Note

Values are initialized to:

• dnp3_retry_strategy_t::min_delay : 1000ms
• dnp3_retry_strategy_t::max_delay : 10000ms

Returns

New instance of dnp3_retry_strategy_t

dnp3_runtime_config_init()

static dnp3_runtime_config_t dnp3_runtime_config_init ( )

static

Initialize the configuration to default values.

Note

Values are initialized to:

• dnp3_runtime_config_t::num_core_threads : 0

Returns

New instance of dnp3_runtime_config_t

dnp3_runtime_create()

dnp3_param_error_t dnp3_runtime_create	(	dnp3_runtime_config_t	config,
		dnp3_runtime_t **	out
	)

Creates a new runtime for running the protocol stack.

Warning

The runtime should be kept alive for as long as it's needed and it should be released with dnp3_runtime_destroy

Parameters

config	Runtime configuration
out	Instance of dnp3_runtime_t

Returns

Error code

dnp3_runtime_destroy()

void dnp3_runtime_destroy

(

dnp3_runtime_t *

instance

)

Destroy a runtime.

This method will gracefully wait for all asynchronous operation to end before returning

Parameters

instance

Instance of dnp3_runtime_t to destroy

dnp3_serial_settings_init()

static dnp3_serial_settings_t dnp3_serial_settings_init ( )

static

Initialize to default values.

Note

Values are initialized to:

• dnp3_serial_settings_t::baud_rate : 9600
• dnp3_serial_settings_t::data_bits : DNP3_DATA_BITS_EIGHT
• dnp3_serial_settings_t::flow_control : DNP3_FLOW_CONTROL_NONE
• dnp3_serial_settings_t::parity : DNP3_PARITY_NONE
• dnp3_serial_settings_t::stop_bits : DNP3_STOP_BITS_ONE

Returns

New instance of dnp3_serial_settings_t

dnp3_static_analog_input_variation_to_string()

static const char * dnp3_static_analog_input_variation_to_string ( dnp3_static_analog_input_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_static_analog_output_status_variation_to_string()

static const char * dnp3_static_analog_output_status_variation_to_string ( dnp3_static_analog_output_status_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_static_binary_input_variation_to_string()

static const char * dnp3_static_binary_input_variation_to_string ( dnp3_static_binary_input_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_static_binary_output_status_variation_to_string()

static const char * dnp3_static_binary_output_status_variation_to_string ( dnp3_static_binary_output_status_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_static_counter_variation_to_string()

static const char * dnp3_static_counter_variation_to_string ( dnp3_static_counter_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_static_double_bit_binary_input_variation_to_string()

static const char * dnp3_static_double_bit_binary_input_variation_to_string ( dnp3_static_double_bit_binary_input_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_static_frozen_counter_variation_to_string()

static const char * dnp3_static_frozen_counter_variation_to_string ( dnp3_static_frozen_counter_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_stop_bits_to_string()

static const char * dnp3_stop_bits_to_string ( dnp3_stop_bits_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_task_error_to_string()

static const char * dnp3_task_error_to_string ( dnp3_task_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_task_type_to_string()

static const char * dnp3_task_type_to_string ( dnp3_task_type_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_time_format_to_string()

static const char * dnp3_time_format_to_string ( dnp3_time_format_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_time_quality_to_string()

static const char * dnp3_time_quality_to_string ( dnp3_time_quality_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_time_sync_error_to_string()

static const char * dnp3_time_sync_error_to_string ( dnp3_time_sync_error_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_time_sync_mode_to_string()

static const char * dnp3_time_sync_mode_to_string ( dnp3_time_sync_mode_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_time_sync_task_callback_init()

static dnp3_time_sync_task_callback_t dnp3_time_sync_task_callback_init ( void(*)(dnp3_nothing_t, void *)  on_complete, void(*)(dnp3_time_sync_error_t, void *)  on_failure, void(*)(void *arg)  on_destroy, void *  ctx  )

static

Initialize an instance of the interface.

Parameters

on_complete	Invoked when the asynchronous operation completes successfully
on_failure	Invoked when the asynchronous operation fails
on_destroy	Callback when the underlying owner doesn't need the interface anymore
ctx	Context data

dnp3_timestamp_invalid_timestamp()

static dnp3_timestamp_t dnp3_timestamp_invalid_timestamp ( )

static

Creates an invalid timestamp struct.

Note

Values are initialized to:

• dnp3_timestamp_t::value : 0
• dnp3_timestamp_t::quality : DNP3_TIME_QUALITY_INVALID_TIME

Returns

New instance of dnp3_timestamp_t

dnp3_timestamp_synchronized_timestamp()

static dnp3_timestamp_t dnp3_timestamp_synchronized_timestamp ( uint64_t  value )

static

Creates a synchronized timestamp struct.

Note

Values are initialized to:

• dnp3_timestamp_t::quality : DNP3_TIME_QUALITY_SYNCHRONIZED_TIME

Parameters

value

Timestamp value

Returns

New instance of dnp3_timestamp_t

dnp3_timestamp_unsynchronized_timestamp()

static dnp3_timestamp_t dnp3_timestamp_unsynchronized_timestamp ( uint64_t  value )

static

Creates an unsynchronized timestamp struct.

Note

Values are initialized to:

• dnp3_timestamp_t::quality : DNP3_TIME_QUALITY_UNSYNCHRONIZED_TIME

Parameters

value

Timestamp value

Returns

New instance of dnp3_timestamp_t

dnp3_tls_client_config_init()

static dnp3_tls_client_config_t dnp3_tls_client_config_init ( const char *  dns_name, const char *  peer_cert_path, const char *  local_cert_path, const char *  private_key_path, const char *  password  )

static

construct the configuration with defaults

Note

Values are initialized to:

• dnp3_tls_client_config_t::min_tls_version : DNP3_MIN_TLS_VERSION_V12
• dnp3_tls_client_config_t::certificate_mode : DNP3_CERTIFICATE_MODE_AUTHORITY_BASED

Parameters

dns_name	Expected name to validate in the presented certificate (only in DNP3_CERTIFICATE_MODE_AUTHORITY_BASED mode)
peer_cert_path	Path to the PEM-encoded certificate of the peer
local_cert_path	Path to the PEM-encoded local certificate
private_key_path	Path to the the PEM-encoded private key
password	Optional password if the private key file is encrypted

Returns

New instance of dnp3_tls_client_config_t

dnp3_tls_server_config_init()

static dnp3_tls_server_config_t dnp3_tls_server_config_init ( const char *  dns_name, const char *  peer_cert_path, const char *  local_cert_path, const char *  private_key_path, const char *  password  )

static

construct the configuration with defaults

Note

Values are initialized to:

• dnp3_tls_server_config_t::min_tls_version : DNP3_MIN_TLS_VERSION_V12
• dnp3_tls_server_config_t::certificate_mode : DNP3_CERTIFICATE_MODE_AUTHORITY_BASED

Parameters

dns_name	Expected name to validate in the presented certificate (only in DNP3_CERTIFICATE_MODE_AUTHORITY_BASED mode)
peer_cert_path	Path to the PEM-encoded certificate of the peer
local_cert_path	Path to the PEM-encoded local certificate
private_key_path	Path to the the PEM-encoded private key
password	Optional password if the private key file is encrypted

Returns

New instance of dnp3_tls_server_config_t

dnp3_transport_decode_level_to_string()

static const char * dnp3_transport_decode_level_to_string ( dnp3_transport_decode_level_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_trip_close_code_to_string()

static const char * dnp3_trip_close_code_to_string ( dnp3_trip_close_code_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_update_options_detect_event()

static dnp3_update_options_t dnp3_update_options_detect_event ( )

static

Default event detection mode. Updates the static value and automatically detects event.

Note

Values are initialized to:

• dnp3_update_options_t::update_static : true
• dnp3_update_options_t::event_mode : DNP3_EVENT_MODE_DETECT

Returns

New instance of dnp3_update_options_t

dnp3_update_options_no_event()

static dnp3_update_options_t dnp3_update_options_no_event ( )

static

Only update the static value. Usefull during initialization of the database.

Note

Values are initialized to:

• dnp3_update_options_t::update_static : true
• dnp3_update_options_t::event_mode : DNP3_EVENT_MODE_SUPPRESS

Returns

New instance of dnp3_update_options_t

dnp3_utc_timestamp_invalid()

static dnp3_utc_timestamp_t dnp3_utc_timestamp_invalid ( )

static

Construct an invalid dnp3_utc_timestamp_t.

Note

Values are initialized to:

• dnp3_utc_timestamp_t::is_valid : false
• dnp3_utc_timestamp_t::value : 0

Returns

New instance of dnp3_utc_timestamp_t

dnp3_utc_timestamp_valid()

static dnp3_utc_timestamp_t dnp3_utc_timestamp_valid ( uint64_t  value )

static

Construct a valid dnp3_utc_timestamp_t.

Note

Values are initialized to:

• dnp3_utc_timestamp_t::is_valid : true

Parameters

value

Value of the timestamp (in milliseconds from UNIX Epoch).

Returns

New instance of dnp3_utc_timestamp_t

dnp3_variation_to_string()

static const char * dnp3_variation_to_string ( dnp3_variation_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation

dnp3_version()

const char * dnp3_version

(

)

Get the version of the library as a string.

Returns

Version number

dnp3_write_time_result_to_string()

static const char * dnp3_write_time_result_to_string ( dnp3_write_time_result_t  value )

static

Converts the enum to a string.

Parameters

value

Enum to convert

Returns

String representation