Package 'socketR'

Description

External-pointer sockets implemented with base R's C API for POSIX TCP, UDP, IPv4, and IPv6 and Unix-domain socket operations, including bind, listen, accept, connect, send, receive, polling, shutdown, close, socket names, and typed options.

Details

Socket handles are RAII-managed external pointers and should still be closed explicitly with socket_close() when possible. Most system-call failures include the POSIX errno name and number.

Author(s)

Maintainer: Eduardo Hellas [email protected]

Authors:

• Eduardo Hellas [email protected]

Other contributors:

• SAS [email protected] [copyright holder, funder]

See Also

Useful links:

• https://sassoftware.github.io/socketr/

Description

Close an R6 Socket with the standard R connection API.

Usage

## S3 method for class 'Socket'
close(con, ...)

Arguments

Description

Close a socketR handle with the standard R connection API.

Usage

## S3 method for class 'socketr_socket'
close(con, ...)

Arguments

Description

The public methods mirror the functional API: is_open(), fd(), info(), set_blocking(), bind(), listen(), accept(), connect(), send(), receive(), send_to(), receive_from(), shutdown(), close(), local_name(), peer_name(), poll(), get_option(), set_option(), and set_options(). They delegate to the corresponding documented functions while retaining the handle as object state.

Use Socket$new_auto() to create a connected client with IPv4/IPv6 fallback, or Socket$new_listener() to create a listening server with IPv4/IPv6 fallback.

Value

An R6 Socket object.

Public fields

Active bindings

Methods

Public methods

• Socket$new()

• Socket$new_auto()

• Socket$new_listener()

• Socket$is_open()

• Socket$fd()

• Socket$info()

• Socket$set_blocking()

• Socket$bind()

• Socket$listen()

• Socket$accept()

• Socket$connect()

• Socket$as_connection()

• Socket$write()

• Socket$read()

• Socket$send()

• Socket$receive()

• Socket$send_to()

• Socket$receive_from()

• Socket$shutdown()

• Socket$close()

• Socket$local_name()

• Socket$peer_name()

• Socket$poll()

• Socket$get_option()

• Socket$set_options()

• Socket$set_option()

• Socket$clone()

Socket$new()

Create a socket wrapper or wrap an existing handle.

Usage

Socket$new(
  domain = c("inet", "inet6", "unix"),
  type = c("stream", "dgram"),
  protocol = 0L,
  nonblocking = FALSE,
  cloexec = TRUE,
  handle = NULL
)

Arguments

Socket$new_auto()

Create a connected client using IPv4/IPv6 endpoint fallback.

Usage

Socket$new_auto(
  address,
  port = NULL,
  type = c("stream", "dgram"),
  protocol = 0L,
  nonblocking = FALSE,
  cloexec = TRUE,
  prefer = c("inet6", "inet")
)

Arguments

Returns

A connected Socket R6 object.

Socket$new_listener()

Create a listener using IPv4/IPv6 endpoint fallback.

Usage

Socket$new_listener(
  address = NULL,
  port = NULL,
  backlog = 128L,
  reuse_address = TRUE,
  cloexec = TRUE,
  prefer = c("inet6", "inet")
)

Arguments

Returns

A listening Socket R6 object.

Socket$is_open()

Test whether the wrapped socket is open.

Usage

Socket$is_open()

Socket$fd()

Return the wrapped socket file descriptor.

Usage

Socket$fd()

Socket$info()

Return metadata for the wrapped socket.

Usage

Socket$info()

Socket$set_blocking()

Set blocking mode.

Usage

Socket$set_blocking(blocking = TRUE)

Arguments

Socket$bind()

Bind the wrapped socket.

Usage

Socket$bind(address = NULL, port = NULL)

Arguments

Socket$listen()

Listen for stream connections.

Usage

Socket$listen(backlog = 128L)

Arguments

Socket$accept()

Accept a pending connection.

Usage

Socket$accept(nonblocking = NULL)

Arguments

Socket$connect()

Connect the wrapped socket.

Usage

Socket$connect(address, port = NULL)

Arguments

Socket$as_connection()

Return the wrapped socket as an R connection.

Usage

Socket$as_connection()

Socket$write()

Write bytes to the wrapped socket.

Usage

Socket$write(object, flags = 0L)

Arguments

Socket$read()

Read bytes from the wrapped socket.

Usage

Socket$read(n = 4096L, flags = 0L)

Arguments

Socket$send()

Send bytes on the wrapped socket.

Usage

Socket$send(data, flags = 0L)

Arguments

Socket$receive()

Receive bytes from the wrapped socket.

Usage

Socket$receive(n = 4096L, flags = 0L)

Arguments

Socket$send_to()

Send a datagram.

Usage

Socket$send_to(data, address, port = NULL, flags = 0L)

Arguments

Socket$receive_from()

Receive a datagram.

Usage

Socket$receive_from(n = 4096L, flags = 0L)

Arguments

Socket$shutdown()

Shut down part of the connection.

Usage

Socket$shutdown(how = c("both", "read", "write"))

Arguments

Socket$close()

Close the wrapped socket.

Usage

Socket$close()

Socket$local_name()

Return the local socket name.

Usage

Socket$local_name()

Socket$peer_name()

Return the peer socket name.

Usage

Socket$peer_name()

Socket$poll()

Poll the wrapped socket.

Usage

Socket$poll(events = "read", timeout_ms = 60000L)

Arguments

Socket$get_option()

Get a socket option.

Usage

Socket$get_option(
  level = "socket",
  option,
  type = c("int", "logical", "timeval", "linger", "raw"),
  size = 256L
)

Arguments

Socket$set_options()

Set multiple socket options.

Usage

Socket$set_options(options)

Arguments

Socket$set_option()

Set a socket option.

Usage

Socket$set_option(
  level = "socket",
  option,
  value,
  type = c("int", "logical", "timeval", "linger", "raw")
)

Arguments

Socket$clone()

The objects of this class are cloneable with this method.

Usage

Socket$clone(deep = FALSE)

Arguments

Description

Resolves address for both requested address families, tries endpoints in prefer order, and creates a socket matching the endpoint that succeeds. This is the address-aware alternative to an "auto" socket domain. It supports IPv4 and IPv6 Internet sockets only; Unix-domain filesystem paths are not resolved by this helper. Use type = "dgram" for UDP or the default type = "stream" for TCP.

Usage

socket_connect_auto(
  address,
  port = NULL,
  type = c("stream", "dgram"),
  protocol = 0L,
  nonblocking = FALSE,
  cloexec = TRUE,
  prefer = c("inet6", "inet")
)

Arguments

Value

A connected socketR handle.

Examples

if (interactive()) {
  client <- socket_connect_auto("localhost", 80L)
  socket_close(client)
}

Description

Adapt a socket handle to an R connection. The returned connection can be passed to base R functions such as readBin(), writeBin(), readLines(), and writeLines(). Closing the connection does not close the underlying socket handle; call socket_close() explicitly when the handle is no longer needed.

Uses R's connection dispatch, so this works with socket_connection() and other readable R connections.

Uses R's connection dispatch, so this works with socket_connection() and other writable R connections.

Usage

socket_connection(socket, close_socket = FALSE)

socket_connection_read(connection, n = 4096L)

socket_connection_write(connection, data)

Arguments

Value

An R connection object.

A raw vector, possibly shorter than n at end-of-file.

Number of bytes written.

Examples

s <- socket_create()
con <- socket_connection(s)
close(con)
socket_close(s)

Description

Send bytes to a datagram destination.

Usage

socket_send_to(socket, data, address, port = NULL, flags = 0L)

socket_receive_from(socket, n = 4096L, flags = 0L)

Arguments

Value

Number of bytes sent, or NA_integer_ if I/O would block.

A list with data and address, or NULL if I/O would block.

Examples

if (interactive()) {
  receiver <- socket_create(type = "dgram")
  sender <- socket_create(type = "dgram")
  socket_bind(receiver, "127.0.0.1", 0L)
  socket_send_to(sender, "hello", "127.0.0.1",
                 socket_local_name(receiver)$port)
  socket_receive_from(receiver)
  socket_close(sender); socket_close(receiver)
}

Description

Return the local socket name.

Usage

socket_fd(socket)

socket_info(socket)

socket_local_name(socket)

socket_peer_name(socket)

Arguments

Value

An integer descriptor or NA_integer_.

A list containing socket metadata.

Address metadata as a list.

Address metadata as a list.

Examples

s <- socket_create()
socket_local_name(s)
socket_close(s)

Description

Get a socket option.

Usage

socket_get_option(
  socket,
  level = "socket",
  option,
  type = c("int", "logical", "timeval", "linger", "raw"),
  size = 256L
)

Arguments

Value

The option value.

Description

Write bytes to a connected socket. This is a connection-style alias for socket_send(). It returns the number of bytes written, which may be less than the input length for a nonblocking socket or a large payload.

This is a connection-style alias for socket_receive(). Blocking sockets wait until at least one byte is available or the peer closes the connection.

Usage

socket_write(socket, object, flags = 0L)

socket_send(socket, data, flags = 0L)

socket_read(socket, n = 4096L, flags = 0L)

socket_receive(socket, n = 4096L, flags = 0L)

Arguments

Value

Number of bytes written, or NA_integer_ if I/O would block.

Number of bytes sent, or NA_integer_ if nonblocking I/O would block.

A raw vector, or NULL if a nonblocking read would block.

A raw vector, or NULL if nonblocking I/O would block.

Examples

if (interactive()) {
  server <- socket_create()
  client <- socket_create()
  socket_bind(server, "127.0.0.1", 0L)
  socket_listen(server)
  socket_connect(client, "127.0.0.1", socket_local_name(server)$port)
  peer <- socket_accept(server)
  socket_write(client, "hello")
  socket_read(peer, 5L)
  socket_close(peer); socket_close(client); socket_close(server)
}

Description

Manage a socket handle lifecycle.

Test whether a socket handle is open.

Shut down part of a full-duplex socket.

Usage

socket_close(socket)

socket_is_open(socket)

socket_shutdown(socket, how = c("both", "read", "write"))

Arguments

Value

Invisibly, TRUE.

A logical scalar.

Invisibly, the socket handle.

Examples

s <- socket_create()
socket_close(s)

Description

Creates a stream listener, tries bind candidates in prefer order, and returns the first listener that binds and listens successfully. When address is NULL, the family wildcard ("::" or "0.0.0.0") is used. This helper supports IPv4 and IPv6 stream sockets only. Unix-domain sockets require an explicit filesystem path with socket_create() and socket_bind().

Usage

socket_listen_auto(
  address = NULL,
  port = NULL,
  backlog = 128L,
  reuse_address = TRUE,
  cloexec = TRUE,
  prefer = c("inet6", "inet")
)

Arguments

Value

A listening socketR handle.

Examples

listener <- socket_listen_auto(port = 0L, prefer = "inet")
socket_local_name(listener)
socket_close(listener)

Description

These helpers read or set frequently used socket options. With the value argument omitted, the current option value is returned; otherwise the option is updated and the socket handle is returned invisibly. The socket_linger() helper uses on and seconds to configure SO_LINGER.

Usage

socket_reuse_address(socket, value)

socket_keep_alive(socket, value)

socket_broadcast(socket, value)

socket_no_delay(socket, value)

socket_quick_ack(socket, value)

socket_receive_buffer_size(socket, value)

socket_send_buffer_size(socket, value)

socket_receive_timeout(socket, value)

socket_send_timeout(socket, value)

socket_linger(socket, on, seconds = 0L)

Arguments

Value

The option value when reading; invisibly, the socket when setting.

Examples

s <- socket_create()
socket_reuse_address(s, TRUE)
socket_reuse_address(s)
socket_close(s)

Description

Control socket blocking and readiness.

Poll sockets for readiness.

Usage

socket_set_blocking(socket, blocking = TRUE)

socket_poll(sockets, events = "read", timeout_ms = 60000L)

Arguments

Value

Invisibly, the socket handle.

A data frame with readiness flags and native revents values.

Examples

s <- socket_create()
socket_set_blocking(s, FALSE)
socket_close(s)


s <- socket_create()
socket_poll(s, "read", timeout_ms = 0L)
socket_close(s)

Description

Resolve a hostname or address into socket endpoints.

Usage

socket_resolve(address, domain = c("inet", "inet6"), port = 0L)

Arguments

Value

A list of resolved endpoint metadata.

Description

Set a socket option.

Usage

socket_set_option(
  socket,
  level = "socket",
  option,
  value,
  type = c("int", "logical", "timeval", "linger", "raw")
)

Arguments

Value

Invisibly, the socket handle.

Description

Each element of options must be a list containing option and value, with optional level and type entries. Options are applied in list order. If a native option fails, the error includes the zero-based count of options already applied in its applied field.

Usage

socket_set_options(socket, options)

Arguments

Value

The socket handle, invisibly.

Description

Create a POSIX socket.

Usage

socket_create(
  domain = c("inet", "inet6", "unix"),
  type = c("stream", "dgram"),
  protocol = 0L,
  nonblocking = FALSE,
  cloexec = TRUE
)

socket_bind(socket, address = NULL, port = NULL)

socket_listen(socket, backlog = 128L)

socket_accept(socket, nonblocking = NULL)

socket_connect(socket, address, port = NULL)

Arguments

Value

A socketR external-pointer handle.

Invisibly, the socket handle.

Invisibly, the socket handle.

A socket handle, or NULL when no connection is pending.

TRUE when connected, or FALSE when connection is in progress.

Examples

s <- socket_create()
socket_close(s)