AssociateEvent

public class AssociateEvent : CommunicationEvent<AssociateEventData>

Associate event

Static Factory Methods.

  • Create an AssociateEvent instance for associating or disassociating the given IO source and IO actor.

    Declaration

    Swift

    public static func with(ioContextName: String,
                        ioSourceId: CoatyUUID,
                        ioActorId: CoatyUUID,
                        associatingRoute: String?,
                        isExternalRoute: Bool? = nil,
                        updateRate: Int? = nil) -> AssociateEvent

    Parameters

    ioContextName

    the name of an IO context the given IO source and actor belong to
    ioSourceId

    the IO source object Id to associate/disassociate
    ioActorId

    the IO actor object Id to associate/disassociate
    associatingRoute

    the IO route used by IO source for publishing and by IO actor for subscribing, or undefined if used for disassocation
    isExternalRoute

    indicates whether the associating route is external (optional)
    updateRate

    the recommended update rate (in millis) for publishing IO source values (optional)

Codable methods.

  • Undocumented

    Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Undocumented

    Declaration

    Swift

    override public func encode(to encoder: Encoder) throws