chrome.socket

Properties

• resultCode

  number
• socketId

  number optional

  The id of the accepted socket.

Properties

• socketId

  number

  The id of the newly created socket.

Properties

• address

  string

  The available IPv4/6 address.

• name

  string

  The underlying name of the adapter. On *nix, this will typically be "eth0", "lo", etc.

• prefixLength

  number

  The prefix length

Properties

• data

  ArrayBuffer
• resultCode

  number

  The resultCode returned from the underlying read() call.

Properties

• address

  string

  The address of the remote machine.

• data

  ArrayBuffer
• port

  number
• resultCode

  number

  The resultCode returned from the underlying recvfrom() call.

Properties

• tlsVersion

  TLSVersionConstraints optional

Properties

• connected

  boolean

  Whether or not the underlying socket is connected.

  For tcp sockets, this will remain true even if the remote peer has disconnected. Reading or writing to the socket may then result in an error, hinting that this socket should be disconnected via disconnect().

  For udp sockets, this just represents whether a default remote address has been specified for reading and writing packets.

• localAddress

  string optional

  If the underlying socket is bound or connected, contains its local IPv4/6 address.

• localPort

  number optional

  If the underlying socket is bound or connected, contains its local port.

• peerAddress

  string optional

  If the underlying socket is connected, contains the IPv4/6 address of the peer.

• peerPort

  number optional

  If the underlying socket is connected, contains the port of the connected peer.

• socketType

  SocketType

  The type of the passed socket. This will be tcp or udp.

Properties

• max

  string optional
• min

  string optional

  The minimum and maximum acceptable versions of TLS. These will be tls1, tls1.1, tls1.2, or tls1.3.

Properties

• bytesWritten

  number

  The number of bytes sent, or a negative error code.

Enum

Parameters

• socketId

  number

  The socketId.

• callback

  function

  The callback is invoked when a new socket is accepted.

  The callback parameter should be a function that looks like this:

  (acceptInfo: AcceptInfo) => {...}

  • acceptInfo

    AcceptInfo

Parameters

• socketId

  number

  The socketId.

• address

  string

  The address of the local machine.

• port

  number

  The port of the local machine.

• callback

  function

  Called when the bind attempt is complete.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• hostname

  string

  The hostname or IP address of the remote machine.

• port

  number

  The port of the remote machine.

• callback

  function

  Called when the connection attempt is complete.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• type

  SocketType

  The type of socket to create. Must be tcp or udp.

• options

  CreateOptions optional

  The socket options.

• callback

  function

  Called when the socket has been created.

  The callback parameter should be a function that looks like this:

  (createInfo: CreateInfo) => {...}

  • createInfo

    CreateInfo

Parameters

• socketId

  number

  The socketId.

Parameters

• socketId

  number

  The socketId.

Parameters

• socketId

  number

  The socketId.

• callback

  function

  Called when the state is available.

  The callback parameter should be a function that looks like this:

  (result: SocketInfo) => {...}

  • result

    SocketInfo

Parameters

• socketId

  number

  The socketId.

• callback

  function

  Called with an array of strings of the result.

  The callback parameter should be a function that looks like this:

  (groups: string[]) => {...}

  • groups

    string[]

Parameters

• callback

  function

  Called when local adapter information is available.

  The callback parameter should be a function that looks like this:

  (result: NetworkInterface[]) => {...}

  • result

    NetworkInterface[]

Parameters

• socketId

  number

  The socketId.

• address

  string

  The group address to join. Domain names are not supported.

• callback

  function

  Called when the join group operation is done with an integer parameter indicating the platform-independent error code.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• address

  string

  The group address to leave. Domain names are not supported.

• callback

  function

  Called when the leave group operation is done with an integer parameter indicating the platform-independent error code.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• address

  string

  The address of the local machine.

• port

  number

  The port of the local machine.

• backlog

  number optional

  Length of the socket's listen queue.

• callback

  function

  Called when listen operation completes.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• bufferSize

  number optional

  The read buffer size.

• callback

  function

  Delivers data that was available to be read without blocking.

  The callback parameter should be a function that looks like this:

  (readInfo: ReadInfo) => {...}

  • readInfo

    ReadInfo

Parameters

• socketId

  number

  The socketId.

• bufferSize

  number optional

  The receive buffer size.

• callback

  function

  Returns result of the recvFrom operation.

  The callback parameter should be a function that looks like this:

  (recvFromInfo: RecvFromInfo) => {...}

  • recvFromInfo

    RecvFromInfo

Parameters

• socketId

  number

  The connected socket to use.

• options

  SecureOptions optional

  Constraints and parameters for the TLS connection.

• callback

  function

  Called when the TLS connection attempt is complete.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• data

  ArrayBuffer

  The data to write.

• address

  string

  The address of the remote machine.

• port

  number

  The port of the remote machine.

• callback

  function

  Called when the send operation completes without blocking or an error occurs.

  The callback parameter should be a function that looks like this:

  (writeInfo: WriteInfo) => {...}

  • writeInfo

    WriteInfo

Parameters

• socketId

  number

  The socketId.

• enable

  boolean

  If true, enable keep-alive functionality.

• delay

  number optional

  Set the delay seconds between the last data packet received and the first keepalive probe. Default is 0.

• callback

  function

  Called when the setKeepAlive attempt is complete.

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• socketId

  number

  The socketId.

• enabled

  boolean

  Indicate whether to enable loopback mode.

• callback

  function

  Called when the configuration operation is done.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• ttl

  number

  The time-to-live value.

• callback

  function

  Called when the configuration operation is done.

  The callback parameter should be a function that looks like this:

  (result: number) => {...}

  • result

    number

Parameters

• socketId

  number

  The socketId.

• noDelay

  boolean

  If true, disables Nagle's algorithm.

• callback

  function

  Called when the setNoDelay attempt is complete.

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• socketId

  number

  The socketId.

• data

  ArrayBuffer

  The data to write.

• callback

  function

  Called when the write operation completes without blocking or an error occurs.

  The callback parameter should be a function that looks like this:

  (writeInfo: WriteInfo) => {...}

  • writeInfo

    WriteInfo