dnp3 (C API) 1.1.0
dnp3_outstation_information_t Struct Reference

Informational callbacks that the outstation doesn't rely on to function. More...

#include <dnp3.h>

Data Fields

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

Detailed Description

Informational callbacks that the outstation doesn't rely on to function.

It may be useful to certain applications to assess the health of the communication or to count statistics

Field Documentation

◆ broadcast_received

void(* dnp3_outstation_information_t::broadcast_received) (dnp3_function_code_t, dnp3_broadcast_action_t, void *)

Called when a broadcast request is received by the outstation.

Parameters
function_codeFunction code received
actionBroadcast action
ctxContext data

◆ clear_restart_iin

void(* dnp3_outstation_information_t::clear_restart_iin) (void *)

Master cleared the restart IIN bit.

Parameters
ctxContext data

◆ ctx

void* dnp3_outstation_information_t::ctx

Context data.

◆ enter_solicited_confirm_wait

void(* dnp3_outstation_information_t::enter_solicited_confirm_wait) (uint8_t, void *)

Outstation has begun waiting for a solicited confirm.

Parameters
ecsnExpected sequence number
ctxContext data

◆ enter_unsolicited_confirm_wait

void(* dnp3_outstation_information_t::enter_unsolicited_confirm_wait) (uint8_t, void *)

Outstation has begun waiting for an unsolicited confirm.

Parameters
ecsnExpected sequence number
ctxContext data

◆ on_destroy

void(* dnp3_outstation_information_t::on_destroy) (void *arg)

Callback when the underlying owner doesn't need the interface anymore.

Parameters
argContext data

◆ process_request_from_idle

void(* dnp3_outstation_information_t::process_request_from_idle) (dnp3_request_header_t, void *)

Called when a request is processed from the IDLE state.

Parameters
headerRequest header
ctxContext data

◆ solicited_confirm_received

void(* dnp3_outstation_information_t::solicited_confirm_received) (uint8_t, void *)

Received the expected confirm.

Parameters
ecsnExpected sequence number
ctxContext data

◆ solicited_confirm_timeout

void(* dnp3_outstation_information_t::solicited_confirm_timeout) (uint8_t, void *)

Failed to receive a solicited confirm before the timeout occurred.

Parameters
ecsnExpected sequence number
ctxContext data

◆ solicited_confirm_wait_new_request

void(* dnp3_outstation_information_t::solicited_confirm_wait_new_request) (void *)

Received a new request while waiting for a solicited confirm, aborting the response series.

Parameters
ctxContext data

◆ unexpected_confirm

void(* dnp3_outstation_information_t::unexpected_confirm) (bool, uint8_t, void *)

Received a confirm when not expecting one.

Parameters
unsolicitedTrue if it's an unsolicited response confirm, false if it's a solicited response confirm
seqReceived sequence number
ctxContext data

◆ unsolicited_confirm_timeout

void(* dnp3_outstation_information_t::unsolicited_confirm_timeout) (uint8_t, bool, void *)

Failed to receive an unsolicited confirm before the timeout occurred.

Parameters
ecsnExpected sequence number
retryIs it a retry
ctxContext data

◆ unsolicited_confirmed

void(* dnp3_outstation_information_t::unsolicited_confirmed) (uint8_t, void *)

Master confirmed an unsolicited message.

Parameters
ecsnExpected sequence number
ctxContext data

◆ wrong_solicited_confirm_seq

void(* dnp3_outstation_information_t::wrong_solicited_confirm_seq) (uint8_t, uint8_t, void *)

Received a solicited confirm with the wrong sequence number.

Parameters
ecsnExpected sequence number
seqReceived sequence number
ctxContext data

The documentation for this struct was generated from the following file: