Module master 

Types and traits specific to masters

Structs

AllObjectsScan

struct representing an “all objects” (QC = 0x06) scan

AssociationConfig

Configuration for a master association

AssociationHandle

Handle used to make requests against a particular outstation associated with the master channel

AuthKey

Authentication key used when opening a file

BlockNumber

Block number used in file read/write operations

Classes

struct recording which event classes and class 0 are enabled

CommandBuilder

Builder object used to create a CommandHeaders

CommandHeaders

Collection of command headers sent from the master API

DeadBandHeader

Represents a single header in a WRITE request to modify dead-bands within the outstation

DirReadConfig

Configuration related to reading a directory

EventClasses

struct recording which event classes are enabled

FailedBlockIncrement

Error returned when a block cannot be incremented

FileCredentials

Credentials for obtaining a file authorization token from the outstation

FileHandle

File handle assigned by the outstation

FileInfo

Information about a file or directory returned from the outstation

FileReadConfig

Configuration related to reading a file

HeaderInfo

Information about the object header and specific variation

Headers

Builder for write requests that hides the underlying type

MasterChannel

Handle to a master communication channel. This handle controls a task running on the Tokio Runtime.

MasterChannelConfig

Configuration for a MasterChannel that is independent of the physical layer

OneByteLimitedCountScan

struct representing a one-byte limited count scan

OneByteRangeScan

struct representing a one-byte range scan

OpenFile

The result of opening a file on the outstation

PollHandle

Handle to a poll bound to a master association

TwoByteLimitedCountScan

struct representing a two-byte limited count scan

TwoByteRangeScan

struct representing a two-byte range scan

Enums

AssociationError

Errors that can occur when adding an association

BadEncoding

Errors that can occur while executing a master task

CommandError

Parent error type for command tasks

CommandMode

Controls how a command request is issued

CommandResponseError

Errors that can occur when verifying the respond to a command request

FileAction

Describes whether a file operation should continue (No) or abort (Yes)

FileError

Errors that can occur during a file operations

FileMode

Mode used when opening files

FileWriteMode

Files can be opened for writing by creating/truncating or appending to an existing file

MasterChannelType

Master channels may be Udp or of a “stream” type such as TCP

PollError

Errors that can occur when adding/modifying polls

ReadHeader

Enum representing all of the allowed scan types

ReadRequest

Enum representing all of the READ request types available from the master API

ReadType

Describes the source of a read event

TaskError

Errors that can occur while executing a master task

TaskType

Task types used in AssociationInformation

TimeSyncError

Parent error type for time sync tasks

TimeSyncProcedure

Controls which time synchronization procedure is used

WriteError

Error type for operations that don’t return anything from the outstation but might fail b/c IIN2 has an error bit set

Traits

AssociationHandler

callbacks associated with a single master to outstation association

AssociationInformation

Informational callbacks that can be used to monitor master communication to a particular outstation. Useful for assessing communication health.

CommandSupport

Trait that provides builder support for a particular command type

FileReader

Callbacks for reading a file

ReadHandler

Trait used to process measurement data received from an outstation