Interface IpNetworkChannel<T>

interface IpNetworkChannel<T> {
    isReliable: boolean;
    maxPayloadSize: number;
    name: string;
    networkAddress: ServerAddressIp;
    type: ChannelType;
    close(): Promise<void>;
    send(data: T): Promise<void>;
}

Type Parameters

T

Hierarchy (view full)

Channel<T>
- IpNetworkChannel

Index

Properties

isReliable maxPayloadSize name networkAddress type

Methods

Properties

isReliable

isReliable: boolean

Is the transport Reliable? UDP is not, TCP and BTP are.

maxPayloadSize

maxPayloadSize: number

Maximum Payload size for this channel

name

name: string

Channel name

networkAddress

networkAddress: ServerAddressIp

type

type: ChannelType

Methods

close

close(): Promise<void>
Method to close the channel

Returns Promise<void>
Inherited from Channel.close
- Defined in packages/general/src/net/Channel.ts:31

send

send(data): Promise<void>
Method to send data to the remote endpoint
Parameters
- data: T
Returns Promise<void>
Inherited from Channel.send
- Defined in packages/general/src/net/Channel.ts:28