@zeroc/ice
    Preparing search index...

    Class WSEndpointInfo

    Provides access to a WebSocket endpoint information.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    compress resource timeout underlying

    Methods

    secure type

    Constructors

    Accessors

    • get compress(): boolean

      Specifies whether or not compression should be used if available when using this endpoint.

      Returns boolean

    • get resource(): string

      The URI configured with the endpoint.

      Returns string

    • get timeout(): number

      The timeout for the endpoint in milliseconds. -1 means no timeout. This timeout is provided for backwards compatibility and has no effect in Ice 3.8 or greater.

      Returns number

    • get underlying(): Ice.EndpointInfo | null

      The information of the underlying endpoint or null if there's no underlying endpoint.

      Returns Ice.EndpointInfo | null

    Methods

    • Returns true if this endpoint's transport is secure (SSL or WSS), false otherwise.

      Returns boolean

      true when the transport is secure, false otherwise.

    • Returns the type of the endpoint.

      Returns number

      The endpoint type.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods