Skip to main content

Crate srad_client

Crate srad_client 

Source
Expand description

Part of srad, a general purpose Sparkplug development library.

This library defines traits and types used to implement Sparkplug clients.

§Feature Flags

  • channel-client: Enables the channel based EventLoop and Client implementation. Disabled by default.

Modules§

channel
A basic EventLoop and Client implementation based on channels

Structs§

DeviceMessage
Represents a message from a Device.
LastWill
struct representing the last will of a Node or Application
Message
A Message struct containing payload and the type of topic it was received on
NodeMessage
Represents a message from a Node.

Enums§

Event
An enum that represents the different types of events an EventLoop implementation can produce.
MessageError
Error types for message processing operations.
MessageKind
An enum representing the different type of message.
StatePayload
An enum representing the different type message published on a STATE topic.

Traits§

Client
A trait for implementing a type that acts as a Sparkplug Client
EventLoop
A trait for implementing a type that acts as a Sparkplug Client’s EventLoop

Functions§

topic_and_payload_to_event
Utility function to help clients convert topic and payload data to an Event

Type Aliases§

DynClient
DynEventLoop