IoValueEvent

public class IoValueEvent : CommunicationEvent<IoValueEventData>

Undocumented

Static Factory Methods.


                    
                    
                    with(ioSource:value:options:)

Create an IoValueEvent instance for the given IO source and IO value.

The IO value can be either JSON compatible or in binary format as a [Uint8] . The data format of the given IO value must conform to the useRawIoValues property of the given IO source. That means, if this property is set to true, the given value must be in binary format; if this property is set to false, the value must be a JSON encodable object. If this constraint is violated, an error is thrown.

Throws

throws if the given value data format does not comply with the IoSource.useRawIoValues option

Declaration

Swift

public static func with(ioSource: IoSource, value: [UInt8], options: [String : Any]) throws -> IoValueEvent

Parameters

`ioSource`	the IoSource for publishing
`value`	a `[UInt8]` value
`options`	binding-specific publication options


                    
                    
                    with(ioSource:value:options:)

Create an IoValueEvent instance for the given IO source and IO value.

Throws

throws if the given value data format does not comply with the IoSource.useRawIoValues option

Declaration

Swift

public static func with(ioSource: IoSource, value: AnyCodable, options: [String : Any]) throws -> IoValueEvent

Parameters

`ioSource`	the IoSource for publishing
`value`	an JSON compatible `AnyCodable` value
`options`	binding-specific publication options

Codable methods.


                    
                    
                    init(from:)

Undocumented

Declaration

Swift

public required init(from decoder: Decoder) throws


                    
                    
                    encode(to:)

Undocumented

Declaration

Swift

public override func encode(to encoder: Encoder) throws