Skip to content

OTPProducerStatus

dsmurfin edited this page Aug 28, 2021 · 3 revisions

OTPProducerStatus

OTP Producer Status

public struct OTPProducerStatus: OTPComponentStatus 

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

Used by implementors for displaying information about discovered Producers.

Inheritance

OTPComponentStatus

Initializers

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

Creates a new OTP Producer Status.

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

Includes identifying and status information.

Parameters

  • name: The human-readable name of this Producer.
  • cid: The CID of this Producer.
  • ipMode: The IP mode of this Producer.
  • ipAddresses: The IP Addresses of this Producer.
  • sequenceErrors: The number of sequence errors from this Producer.
  • state: The state of this Producer.
  • online: Optional: Whether this Producer is considered online.

Properties

cid

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

public let cid: UUID

name

A human-readable name for the producer.

public var name: String

ipMode

The IP mode of the producer.

public var ipMode: OTPIPMode

ipAddresses

The IP addresses of the producer.

public var ipAddresses: [String]

sequenceErrors

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

public var sequenceErrors: Int

state

The status of this producer.

public var state: OTPComponentState
Clone this wiki locally