Class OpaqueEndpointInfo

Provides access to the details of an opaque endpoint.

See

Endpoint

Hierarchy (View Summary)

Ice.EndpointInfo
- OpaqueEndpointInfo

Index

Constructors

Accessors

compress rawBytes rawEncoding timeout underlying

Methods

Constructors

constructor

new OpaqueEndpointInfo(): OpaqueEndpointInfo
Returns OpaqueEndpointInfo
Inherited from EndpointInfo.constructor

Accessors

compress

get compress(): boolean
Specifies whether or not compression should be used if available when using this endpoint.

Returns boolean
Inherited from EndpointInfo.compress

rawBytes

get rawBytes(): ByteSeq
The raw bytes of the opaque endpoint.

Returns ByteSeq

rawEncoding

get rawEncoding(): EncodingVersion
The encoding version of the opaque endpoint (to decode or encode the rawBytes).

Returns EncodingVersion

timeout

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
Inherited from EndpointInfo.timeout

underlying

get underlying(): Ice.EndpointInfo | null
The information of the underlying endpoint or null if there's no underlying endpoint.

Returns Ice.EndpointInfo | null
Inherited from EndpointInfo.underlying

Methods

secure

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

Returns boolean
true when the transport is secure, false otherwise.

Inherited from EndpointInfo.secure

type

type(): number
Returns the type of the endpoint.

Returns number
The endpoint type.

Inherited from EndpointInfo.type