URLEndpointListener

@available(macOS 10.12, iOS 10.0, *)
public class URLEndpointListener

ENTERPRISE EDITION ONLY.

A listener to provide websocket based endpoint for peer-to-peer replication. Once the listener is started, peer replicators can connect to the listener by using URLEndpoint

  • Current connection status of the listener.

    See more

    Declaration

    Swift

    public struct ConnectionStatus

  • The read-only configuration.

    Declaration

    Swift

    public var config: URLEndpointListenerConfiguration { get }

  • The listening port of the listener. If the listener is not started, the port will be nil

    Declaration

    Swift

    public var port: UInt16? { get }

  • The TLS identity used by the listener to provide TLS communication. If the listener is not started or the TLS is disabled, the property value will be nil.

    Declaration

    Swift

    public var tlsIdentity: TLSIdentity? { get }

  • The URLs of the listener. If the network interface is specified, return only single URL that reflects the network interface address else gather all possible URLs. If the listener is not started, will return nil

    Declaration

    Swift

    public var urls: [URL]? { get }

  • The connection status of the listener

    Declaration

    Swift

    public var status: ConnectionStatus { get }

  • Initializes a listener with the given configuration object.

    Declaration

    Swift

    public init(config: URLEndpointListenerConfiguration)

  • Starts the listener.

    Declaration

    Swift

    public func start() throws

  • Stop the listener.

    Declaration

    Swift

    public func stop()