Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecureWebSocketConnection

The SecureWebSocketConnection class is identical to WebSocketConnection except that it performs communications over WSS (i.e., an encrypted TLS or SSL socket connection) rather than plain WebSocket.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly target

target: EventDispatcher

Methods

addEventListener

  • addEventListener(type: string, listener: Function, thisArg: any, priority?: number): boolean
  • Parameters

    • type: string
    • listener: Function
    • thisArg: any
    • Default value priority: number = 0

    Returns boolean

applyAffinity

  • applyAffinity(data?: any): void

connect

  • connect(): void

disconnect

  • disconnect(): void

dispatchEvent

  • dispatchEvent(event: Event): void
  • Parameters

    • event: Event

    Returns void

dispose

  • dispose(): void

getHost

  • getHost(): string | null
  • Returns the host on which the connection will be opened or has been opened.

    Returns string | null

    The host name or ip, as a string.

getListeners

  • getListeners(type: string): EventListener[]
  • Parameters

    • type: string

    Returns EventListener[]

getNewSocket

  • getNewSocket(): void

getPort

  • getPort(): number | null
  • Returns the port on which the connection will be opened or has been opened.

    Returns number | null

    A number from 1 to 65535.

getRequestedHost

  • getRequestedHost(): string | null
  • Returns the host that was requested for this connection via setServer(). If that host is a load balancing DNS server, the actual host used for the connection (as returned by getHost()) might differ from the requested host.

    Returns string | null

    The requested host name or ip, as a string.

getType

  • getType(): string | null
  • Returns the type of the connection, as one of the types specified by the ConnectionType class.

    Returns string | null

    A string representing the connection type.

hasListener

  • hasListener(type: string, listener: Function, thisArg: any): boolean
  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

isReady

  • isReady(): boolean

isValid

  • isValid(): boolean
  • Indicates whether this connection is considered valid. Valid connections are those that are currently in a "ready" state, or are currently disconnected but successfully achieved a "ready" state in the most recent connection attempt.

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: Function, thisArg: any): boolean
  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

send

  • send(data?: any): void

setOrbiter

  • setOrbiter(orbiter: Orbiter): void
  • Assigns the Orbiter object for which this IConnection will provide server communication services. This method is invoked automatically by the ConnectionManager when the Connection object is added to the ConnectionManager's connection list.

    Parameters

    Returns void

setServer

  • setServer(host?: undefined | string, port?: undefined | number): void
  • Assigns the host and port to use with the connect() method.

    Parameters

    • Optional host: undefined | string

      The server address (typically an IP address or domain name).

    • Optional port: undefined | number

      A port number between 1 and 65536. Note that ports from 1-7 are normally reserved for use by the operating system!

    Returns void

toString

  • toString(): string