LaneScope

public protocol LaneScope : class

Facilitates the creation and management of downlinks to a single lane of some service instance.

  • The URI of the network endpoint to which the scope is bound.

    Declaration

    Swift

    var hostUri: <<error type>> { get }

  • The URI of the service to which the scope is bound. An absolute URI resolved against hostUri.

    Declaration

    Swift

    var nodeUri: <<error type>> { get }

  • The URI of the lane to which the scope is bound.

    Declaration

    Swift

    var laneUri: <<error type>> { get }

  • Undocumented

    Declaration

    Swift

    public protocol LaneScope : class

  • Undocumented

    Declaration

    Swift

    public protocol LaneScope : class

  • Declaration

    Swift

    func syncList(properties properties: LaneProperties, objectMaker: (SwimValue -> SwimModelProtocolBase?)) -> <<error type>>

    Parameters

    objectMaker

    A callback that will construct a model object given the SwimValue received from the server. This effectively tells the ListDownlink what type of model object should be constructed when a new value is received.

  • Undocumented

    Declaration

    Swift

    public protocol LaneScope : class

  • Undocumented

    Declaration

    Swift

    public protocol LaneScope : class

  • Undocumented

    Declaration

    Swift

    public protocol LaneScope : class

  • Sends a command to the remote lane to which this scope is bound.

       let chat = client.scope(node: "ws://swim.example.com/chat/public", lane: "chat/room")
   chat.command(body: "Hello, world!")

    Declaration

    Swift

    func command(body body: SwimValue) -> <<error type>>

  • Unlinks all downlinks registered with the scope.

    Declaration

    Swift

    func close()