Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ITcpIp

ITcp have api and monitoring data variable. These elements are related to TCP/IP communication function.

api-version

1

user

Hierarchy

  • ITcpIp

Index

Properties

Methods

Properties

tcpClientMessageReceived

tcpClientMessageReceived: Monitorable<TcpCommunicationMonitoringData>

Monitorable Client socket message received

api-version

1

user

tcpClientNotifyDisconnect

tcpClientNotifyDisconnect: Monitorable<TcpCommunicationMonitoringData>

Monitorable Client socket is disconnected. The unique ID of the server to which the client is disconnected.

api-version

1

user

tcpClientNotifyReconnect

tcpClientNotifyReconnect: Monitorable<TcpCommunicationMonitoringData>

Monitorable Client socket is recoonected. Unique id of the server to which the client is connected.

api-version

1

user

tcpServerMessageReceived

tcpServerMessageReceived: Monitorable<TcpCommunicationMonitoringData>

Monitorable Server socket message received

api-version

1

user

tcpServerNotifyDisconnect

tcpServerNotifyDisconnect: Monitorable<TcpCommunicationMonitoringData>

Monitorable The connected client is disconnected.

api-version

1

user

tcpServerNotifyNewConnect

tcpServerNotifyNewConnect: Monitorable<TcpCommunicationMonitoringData>

Monitorable A new client is connected to the server socket.

api-version

1

user

Methods

close

  • Close TCP comm

    api-version

    1

    user

    Parameters

    • uniqueId: number

      Unique id.

    Returns Promise<TcpCommunicationResult>

    errorType: ErrorType, result: Fulfills with true if the request has been operated successfully, otherwise false.

open

  • open(uniqueId: number, mode: TcpCommunicationMode, ipAddress: string, portIndex: number): Promise<TcpCommunicationResult>

  • Open TCP Server or Connect to TCP Server(Client)

    api-version

    1

    user

    Parameters

    • uniqueId: number

      Unique id.

    • mode: TcpCommunicationMode
    • ipAddress: string

      Ip address for client mode

    • portIndex: number

      Port number

    Returns Promise<TcpCommunicationResult>

    errorType: ErrorType, result: Unique ID of created comm.

queryClientInfo

queryServerInfo

sendToClient

  • sendToClient(uniqueID: number, clientId: number, data: string | Uint8Array): Promise<boolean>

  • Write data using server socket

    api-version

    1

    user

    Parameters

    • uniqueID: number

      Unique id.

    • clientId: number
    • data: string | Uint8Array

      The data to be sent

    Returns Promise<boolean>

    errorType: ErrorType, result: Fulfills with true if the request has been operated successfully, otherwise false.

sendToServer

  • sendToServer(uniqueId: number, data: string | Uint8Array): Promise<boolean>

  • Write data using client socket

    api-version

    1

    user

    Parameters

    • uniqueId: number

      Unique id.

    • data: string | Uint8Array

      The data to be sent.

    Returns Promise<boolean>

    errorType: ErrorType, result: Fulfills with true if the request has been operated successfully, otherwise false.

Generated using TypeDoc