OTPConsumerStatus

OTPConsumerStatus

OTP Consumer Status

public struct OTPConsumerStatus: OTPComponentStatus 

Stores the status of an OTPConsumer, including its name, state (online/offline) and errors.

Used by implementors for displaying information about discovered Consumers.

Inheritance

OTPComponentStatus

Initializers

init(name:cid:ipMode:ipAddresses:sequenceErrors:state:moduleIdentifiers:)

Creates a new OTP Consumer Status.

public init(name: String, cid: UUID, ipMode: OTPIPMode, ipAddresses: [String], sequenceErrors: Int, state: OTPComponentState, moduleIdentifiers: [OTPModuleIdentifier]) 

Includes identifying and status information.

Parameters

• name: The human-readable name of this Consumer.
• cid: The CID of this Consumer.
• ipMode: The IP mode of this Consumer.
• ipAddresses: The IP Addresses of this Consumer.
• sequenceErrors: The number of sequence errors from this Consumer.
• state: The state of this Consumer.
• moduleIdentifiers: The supported module identifiers of this Consumer.

Properties

cid

A globally unique identifier (UUID) representing the consumer, compliant with RFC 4122.

public let cid: UUID

name

A human-readable name for the consumer.

public var name: String

ipMode

The IP mode of the producer.

public var ipMode: OTPIPMode

ipAddresses

The IP addresses of the consumer.

public var ipAddresses: [String]

sequenceErrors

The number of sequence errors in advertisement messages from the consumer.

public var sequenceErrors: Int

state

The state of this consumer.

public var state: OTPComponentState

supportedModuleIdentifiers

A list of the module identifiers supported by this consumer.

public var supportedModuleIdentifiers: [String]