Interface TcpSocket

Tcp socket连接对象

Hierarchy

Readable
Writable
Closable
IEventSource<{
    close: [];
    data: [ArrayBuffer];
    error: [object];
}>
- TcpSocket

Index

Properties

isClosed localAddress localPort remoteAddress remotePort

Methods

close emit off on once read write writeAll

Properties

`Readonly` isClosed

isClosed: boolean

连接是否已关闭?

`Readonly` localAddress

localAddress: undefined | string

本地地址。如果连接已关闭，返回undefined

`Readonly` localPort

localPort: undefined | number

本地端口。如果连接已关闭，返回undefined

`Readonly` remoteAddress

remoteAddress: undefined | string

远端地址。如果连接已关闭，返回undefined

`Readonly` remotePort

remotePort: undefined | number

远端端口。如果连接已关闭，返回undefined

Methods

close

close(): Promise<void>
关闭数据流

Returns Promise<void>

Inherited from Closable.close

emit

emit<T>(type: T, ...args: {
    close: [];
    data: [ArrayBuffer];
    error: [object];
}[T]): TcpSocket
触发事件
Type Parameters
- T extends "data" | "close" | "error"
Parameters
- type: T
  
  事件类型
- Rest ...args: {
      close: [];
      data: [ArrayBuffer];
      error: [object];
  }[T]
  
  事件参数
Returns TcpSocket

Inherited from IEventSource.emit

off

off<T>(type: T, handler: ((...args: {
    close: [];
    data: [ArrayBuffer];
    error: [object];
}[T]) => void)): TcpSocket
取消监听
Type Parameters
- T extends "data" | "close" | "error"
Parameters
- type: T
- handler: ((...args: {
      close: [];
      data: [ArrayBuffer];
      error: [object];
  }[T]) => void)
  - - (...args: {
          close: [];
          data: [ArrayBuffer];
          error: [object];
      }[T]): void
    - Parameters
      
      Rest ...args: {
          close: [];
          data: [ArrayBuffer];
          error: [object];
      }[T]
      
      Returns void
Returns TcpSocket

Inherited from IEventSource.off

on

on<T>(type: T, handler: ((...args: {
    close: [];
    data: [ArrayBuffer];
    error: [object];
}[T]) => void)): TcpSocket
添加监听
Type Parameters
- T extends "data" | "close" | "error"
Parameters
- type: T
  
  Event type
- handler: ((...args: {
      close: [];
      data: [ArrayBuffer];
      error: [object];
  }[T]) => void)
  
  A callback function to process the incomming event
  - - (...args: {
          close: [];
          data: [ArrayBuffer];
          error: [object];
      }[T]): void
    - Parameters
      
      Rest ...args: {
          close: [];
          data: [ArrayBuffer];
          error: [object];
      }[T]
      
      Returns void
Returns TcpSocket

Inherited from IEventSource.on

once

once<T>(type: T, handler: ((...args: {
    close: [];
    data: [ArrayBuffer];
    error: [object];
}[T]) => void)): TcpSocket
添加一次性监听
Type Parameters
- T extends "data" | "close" | "error"
Parameters
- type: T
  
  Event type
- handler: ((...args: {
      close: [];
      data: [ArrayBuffer];
      error: [object];
  }[T]) => void)
  
  A callback function to process the incomming event
  - - (...args: {
          close: [];
          data: [ArrayBuffer];
          error: [object];
      }[T]): void
    - Parameters
      
      Rest ...args: {
          close: [];
          data: [ArrayBuffer];
          error: [object];
      }[T]
      
      Returns void
Returns TcpSocket

Inherited from IEventSource.once

read

read(buffer: BufferedType): Promise<number>
读取数据到指定缓冲对象。

Returns
实际读取的字节数。
Parameters
- buffer: BufferedType
  
  缓冲对象
Returns Promise<number>

Inherited from Readable.read

write

write(data: string | BufferedType | Byte[]): Promise<number>
向数据流写数据，返回实际写入的字节数。

Returns
实际写入的字节数
Parameters
- data: string | BufferedType | Byte[]
  
  数据
Returns Promise<number>

Inherited from Writable.write

writeAll

writeAll(data: string | BufferedType | Byte[]): Promise<void>
写入全部数据
Parameters
- data: string | BufferedType | Byte[]
  
  数据
Returns Promise<void>

Inherited from Writable.writeAll

Interface TcpSocket

Hierarchy

Index

Properties

Methods

Properties

Readonly isClosed

Readonly localAddress

Readonly localPort

Readonly remoteAddress

Readonly remotePort

Methods

close

Returns Promise<void>

emit

Type Parameters

T extends "data" | "close" | "error"

Parameters

type: T

Rest ...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]

Returns TcpSocket

off

Type Parameters

T extends "data" | "close" | "error"

Parameters

type: T

handler: ((...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]) => void)

Parameters

Rest ...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]

Returns void

Returns TcpSocket

on

Type Parameters

T extends "data" | "close" | "error"

Parameters

type: T

handler: ((...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]) => void)

Parameters

Rest ...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]

Returns void

Returns TcpSocket

once

Type Parameters

T extends "data" | "close" | "error"

Parameters

type: T

handler: ((...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]) => void)

Parameters

Rest ...args: { close: []; data: [ArrayBuffer]; error: [object]; }[T]

Returns void

Returns TcpSocket

read

Returns

Parameters

buffer: BufferedType

Returns Promise<number>

write

Returns

Parameters

data: string | BufferedType | Byte[]

Returns Promise<number>

writeAll

Parameters

data: string | BufferedType | Byte[]

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` isClosed

`Readonly` localAddress

`Readonly` localPort

`Readonly` remoteAddress

`Readonly` remotePort

`Rest` ...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]

handler: ((...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]) => void)

`Rest` ...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]

handler: ((...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]) => void)

`Rest` ...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]

handler: ((...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]) => void)

`Rest` ...args: {
close: [];
data: [ArrayBuffer];
error: [object];
}[T]