Skip to main content

PushSetup

Struct PushSetup 

Source
pub struct PushSetup {
Show 14 fields version: u8, logical_name: ObisCode, push_object_list: Vec<CaptureObjectDefinition>, send_destination_and_method: SendDestinationAndMethod, communication_window: Vec<CommunicationWindow>, randomisation_start_interval: u16, number_of_retries: u8, repetition_delay: CosemDataType, port_reference: Vec<u8>, push_client_sap: i8, push_protection_parameters: Vec<PushProtectionParameter>, push_operation_method: u8, confirmation_parameters: ConfirmationParameters, last_confirmation_date_time: DateTime,
}
Expand description

Push setup interface class (class_id = 40) per IEC 62056-6-2 §4.4.8. Holds the configuration of the server’s unsolicited (push) output.

All three versions are supported:

  • version 0 — attributes 1..7, method push;
  • version 1 — attributes 1..10, method push;
  • version 2 — attributes 1..13, methods push and reset.

In versions 0 and 1 attribute 7 (repetition_delay) is a long-unsigned; in version 2 it is a structure. The push ACTION only validates that the object is triggerable; assembling and sending the actual DataNotification is done by RequestDispatcher::build_push_delivery_request, which has access to the live object registry that this class does not hold.

Fields§

§version: u8§logical_name: ObisCode§push_object_list: Vec<CaptureObjectDefinition>§send_destination_and_method: SendDestinationAndMethod§communication_window: Vec<CommunicationWindow>§randomisation_start_interval: u16§number_of_retries: u8§repetition_delay: CosemDataType§port_reference: Vec<u8>§push_client_sap: i8§push_protection_parameters: Vec<PushProtectionParameter>§push_operation_method: u8§confirmation_parameters: ConfirmationParameters§last_confirmation_date_time: DateTime

Implementations§

Source§

impl PushSetup

Source

pub fn new(config: PushSetupConfig) -> Self

Builds a new PushSetup from its configuration.

Source

fn push() -> CosemDataType

Method 1: push — triggers sending the push object list to the destination (IEC 62056-6-2 §4.4.8.3.1). Building the notification body requires reading the live values of the referenced objects, which this class does not hold; use RequestDispatcher::build_push_delivery_request against the object registry to actually assemble and send the push. The ACTION itself only validates that the object is triggerable.

Source

fn reset(&mut self) -> CosemDataType

Method 2: reset — resets the push confirmation state by clearing last_confirmation_date_time.

Source

pub fn push_object_list(&self) -> &[CaptureObjectDefinition]

Returns the push object list (attribute 2): the objects and attribute indices to read when assembling a push.

Source

pub fn send_destination_and_method(&self) -> &SendDestinationAndMethod

Returns the send-destination-and-method (attribute 3).

Source

pub fn push_client_sap(&self) -> i8

Returns the push client SAP (attribute 9, 0 in versions without it).

Trait Implementations§

Source§

impl Clone for PushSetup

Source§

fn clone(&self) -> PushSetup

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PushSetup

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PushSetup

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl InterfaceClass for PushSetup

Source§

fn class_id(&self) -> u16

Returns the class id (class_id) as defined in IEC 62056-6-2.
Source§

fn version(&self) -> u8

Returns the class version.
Source§

fn logical_name(&self) -> &ObisCode

Returns the object’s logical name (OBIS code).
Source§

fn attributes(&self) -> Vec<(u8, CosemDataType)>

Returns the class attributes as (attribute_id, value) pairs.
Source§

fn methods(&self) -> Vec<(u8, String)>

Returns the class methods as (method_id, name) pairs.
Source§

fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError>

Serializes the object into BER. Read more
Source§

fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError>

Deserializes the object from BER data. Read more
Source§

fn set_attribute( &mut self, attribute_id: u8, value: CosemDataType, ) -> Result<(), String>

Writes the value of a writable attribute. The default implementation rejects the write; classes with writable attributes override it. Read more
Source§

fn invoke_method( &mut self, method_id: u8, _params: Option<CosemDataType>, ) -> Result<CosemDataType, String>

Invokes the object method with the given id. Read more
Source§

fn as_any(&self) -> &dyn Any

Returns the object as dyn Any for dynamic downcasting.
Source§

impl Serialize for PushSetup

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more