r_gen_tcp

Types

ConnectOption

connect_option/0

pub type ConnectOption

ListenError

</>

Reimplements errors returned by Listen/1.

pub type ListenError {
  SystemLimit
  Eaddrinuse
  Eaddrnotavail
  Eafnosupport
  Ealready
  Econnaborted
  Econnrefused
  Econnreset
  Edestaddrreq
  Ehostdown
  Ehostunreach
  Einprogress
  Eisconn
  Emsgsize
  Enetdown
  Enetunreach
  Enopkg
  Enoprotoopt
  Enetconn
  Enotty
  Enotsock
  Eproto
  Eprotonosupport
  Eprototype
  Esocktnosupport
  Etimedout
  Ewouldblock
  Exbadport
  Exbadseq
  Eacces
  Enotblk
  Enotdir
  Eagain
  Ebadf
  Ebadmsg
  Ebusy
  Edeadlk
  Edeadlock
  Edquot
  Eexist
  Efault
  Efbig
  Eftype
  Eintr
  Einval
  Eio
  Eisdir
  Enolck
  Enolink
  Enoent
  Enomem
  Enospc
  Enosr
  Enostr
  Enosys
  Eloop
  Emfile
  Emlink
  Emultihop
  Enametoolong
  Enfile
  Enobufs
  Enodev
  Enotsup
  Enxio
  Eopnotsupp
  Eoverflow
  Eperm
  Epipe
  Erange
  Erofs
  Espipe
  Esrch
  Estale
}

Constructors

```
SystemLimit
```
```
Eaddrinuse
```
```
Eaddrnotavail
```
```
Eafnosupport
```
```
Ealready
```
```
Econnaborted
```
```
Econnrefused
```
```
Econnreset
```
```
Edestaddrreq
```
```
Ehostdown
```
```
Ehostunreach
```
```
Einprogress
```
```
Eisconn
```
```
Emsgsize
```
```
Enetdown
```
```
Enetunreach
```
```
Enopkg
```
```
Enoprotoopt
```
```
Enetconn
```
```
Enotty
```
```
Enotsock
```
```
Eproto
```
```
Eprotonosupport
```
```
Eprototype
```
```
Esocktnosupport
```
```
Etimedout
```
```
Ewouldblock
```
```
Exbadport
```
```
Exbadseq
```
```
Eacces
```
```
Enotblk
```
```
Enotdir
```
```
Eagain
```
```
Ebadf
```
```
Ebadmsg
```
```
Ebusy
```
```
Edeadlk
```
```
Edeadlock
```
```
Edquot
```
```
Eexist
```
```
Efault
```
```
Efbig
```
```
Eftype
```
```
Eintr
```
```
Einval
```
```
Eio
```
```
Eisdir
```
```
Enolck
```
```
Enolink
```
```
Enoent
```
```
Enomem
```
```
Enospc
```
```
Enosr
```
```
Enostr
```
```
Enosys
```
```
Eloop
```
```
Emfile
```
```
Emlink
```
```
Emultihop
```
```
Enametoolong
```
```
Enfile
```
```
Enobufs
```
```
Enodev
```
```
Enotsup
```
```
Enxio
```
```
Eopnotsupp
```
```
Eoverflow
```
```
Eperm
```
```
Epipe
```
```
Erange
```
```
Erofs
```
```
Espipe
```
```
Esrch
```
```
Estale
```

ListenOption

</>

listen_option/0

pub type ListenOption

{fd, Fd :: non_neg_integer()} | inet:address_family() | {ifaddr, socket:sockaddr_in() | socket:sockaddr_in6() | inet:socket_address()} | {ip, inet:socket_address()} | {port, inet:port_number()} | {backlog, B :: non_neg_integer()} | {tcp_module, module()} | {netns, file:filename_all()} | {bind_to_device, binary()} OR -type option() :: {active, true | false | once | -32768..32767} | {buffer, non_neg_integer()} | {debug, boolean()} | {delay_send, boolean()} | {deliver, port | term} | {dontroute, boolean()} | {exit_on_close, boolean()} | {exclusiveaddruse, boolean()} | {header, non_neg_integer()} | {high_msgq_watermark, pos_integer()} | {high_watermark, non_neg_integer()} | {keepalive, boolean()} | {linger, {boolean(), non_neg_integer()}} | {low_msgq_watermark, pos_integer()} | {low_watermark, non_neg_integer()} | {mode, list | binary} | list | binary | {nodelay, boolean()} | {packet, 0 | 1 | 2 | 4 | raw | sunrm | asn1 | cdr | fcgi | line | tpkt | http | httph | http_bin | httph_bin} | {packet_size, non_neg_integer()} | {priority, non_neg_integer()} | {raw, Protocol :: non_neg_integer(), OptionNum :: non_neg_integer(), ValueBin :: binary()} | {recbuf, non_neg_integer()} | {reuseaddr, boolean()} | {reuseport, boolean()} | {reuseport_lb, boolean()} | {send_timeout, non_neg_integer() | infinity} | {send_timeout_close, boolean()} | {show_econnreset, boolean()} | {sndbuf, non_neg_integer()} | {tos, non_neg_integer()} | {tclass, non_neg_integer()} | {ttl, non_neg_integer()} | {recvtos, boolean()} | {recvtclass, boolean()} | {recvttl, boolean()} | {ipv6_v6only, boolean()}.

pub type ListenOptions {
  Active(Bool)
  Buffer(Int)
  Debug(Bool)
  DelaySend(Bool)
  Deliver
  Dontroute(Bool)
  ExitOnClose(Bool)
  Exclusiveaddruse(Bool)
  Header(Int)
  HighMsgqWatermark(Int)
  HighWatermark(Int)
  Keepalive(Bool)
  Linger(#(Bool, Int))
  LowMsgqWatermark(Int)
  LowWatermark(Int)
  Mode(String)
  List
  Binary
  Nodelay(Bool)
  Packet
  Raw
  RecBuf(Int)
  Reuseaddr(Bool)
  Reuseport(Bool)
  ReuseportLb(Bool)
  SendTimeout(Int)
  SendTimeoutClose(Bool)
  ShowEconnreset(Bool)
  Sndbuf(Int)
  Tos(Int)
  Tclass(Int)
  Ttl(Int)
  Recvtos(Bool)
  Recvtclass(Bool)
  Ipv6Only(Bool)
  Recvttl(Bool)
  Fd(Int)
  Inet
  Ifaddr
  Ip
  Port(Int)
  Backlog(Int)
  TcpModule(r_erlang.Module)
  NetNs(String)
  BindToDevice(Bool)
}

Constructors

```
Active(Bool)
```
SAME AS IN r_gen_tcp_options.gleam, but it is an ugly hack because the Gleam does not support redefining types This option is not fully supported
```
Buffer(Int)
```
This option accepts non-negative integer
```
Debug(Bool)
```
```
DelaySend(Bool)
```
```
Deliver
```
This option is broken
```
Dontroute(Bool)
```
```
ExitOnClose(Bool)
```
```
Exclusiveaddruse(Bool)
```
```
Header(Int)
```
Partial implementation
```
HighMsgqWatermark(Int)
```
Partial implementation
```
HighWatermark(Int)
```
Should be non_neg_integer
```
Keepalive(Bool)
```
```
Linger(#(Bool, Int))
```
```
LowMsgqWatermark(Int)
```
Partial implementation
```
LowWatermark(Int)
```
Partial implementation
```
Mode(String)
```
BROKEN: should be atom
```
List
```
```
Binary
```
```
Nodelay(Bool)
```
```
Packet
```
Missing implementation
```
Raw
```
Missing implementation
```
RecBuf(Int)
```
```
Reuseaddr(Bool)
```
```
Reuseport(Bool)
```
```
ReuseportLb(Bool)
```
```
SendTimeout(Int)
```
Send Timeout set to non-neg integer. If infinity is desired, omit this option
```
SendTimeoutClose(Bool)
```
```
ShowEconnreset(Bool)
```
```
Sndbuf(Int)
```
Shall be non-neg-int
```
Tos(Int)
```
Shall be non-neg-int
```
Tclass(Int)
```
Shall be non-neg-int
```
Ttl(Int)
```
Shall be non-neg-int
```
Recvtos(Bool)
```
```
Recvtclass(Bool)
```
```
Ipv6Only(Bool)
```
```
Recvttl(Bool)
```
```
Fd(Int)
```
```
Inet
```
```
Ifaddr
```
```
Ip
```
Missing part
```
Port(Int)
```
Partially incompatible - needs to be checked
```
Backlog(Int)
```
Partially incompatible
```
TcpModule(r_erlang.Module)
```
Not working
```
NetNs(String)
```
Shall be file:filename_all()
```
BindToDevice(Bool)
```

Option

</>

option/0

pub type Option

OptionName

</>

option_name/0

pub type OptionName

Packet

</>

string/0; binary/0 or… HttpPacket (Any)

pub type Packet

PktoptionsValue

</>

pktoptions_value/0

pub type PktoptionsValue

ShutdownMethod

</>

pub type ShutdownMethod {
  Read
  Write
  ReadWrite
}

Constructors

```
Read
```
```
Write
```
```
ReadWrite
```

Socket

</>

socket/0

pub type Socket

Functions

r_accept_1

</>

pub fn r_accept_1(
  listensocket listensocket: Socket,
) -> Result(Socket, AcceptError)

accept/1

r_accept_2

</>

pub fn r_accept_2(
  listensocket listensocket: Socket,
  timeout timeout: Int,
) -> Result(Socket, AcceptError)

accept/2 If you want timeout to be infinite, use accept/1 (r_accept_1)

r_close_1

</>

pub fn r_close_1(socket socket: Socket) -> Nil

close/1 This function in reality returns “ok” atom.

r_controlling_process_2

</>

pub fn r_controlling_process_2(
  socket socket: Socket,
  pid pid: Pid,
) -> Result(Nil, Dynamic)

controlling_process/2 Partially broken implementation. Does not resolve with correct error. Error can be unpacked manually

r_listen_2

</>

pub fn r_listen_2(
  port port: Int,
  options options: List(ListenOptions),
) -> Result(Socket, ListenError)

(listen/2) Port has to be integer in range: 0..65535 This function does not check for correct port erlang: listen(Port, Options) -> {ok, ListenSocket} | {error, Reason}

       Port :: inet:port_number(),
       Options :: [inet:inet_backend() | listen_option()],
       ListenSocket :: socket(),
       Reason :: system_limit | inet:posix().

inet:posix() errors are reimplemented in ListenError type

This implementation is broken, as it does not support multiple options

r_recv_2

</>

pub fn r_recv_2(
  socket: Socket,
  length: Int,
) -> Result(Packet, Dynamic)

recv/2 This implementation is lacking proper error handling

r_recv_3

</>

pub fn r_recv_3(
  socket: Socket,
  length: Int,
  timeout timeout: Int,
) -> Result(Packet, Dynamic)

recv/3 Receive a packet, from a socket in passive mode. A closed socket is indicated by the return value {error, closed}. If the socket is not in passive mode, the return value is {error, einval}. Argument Length is only meaningful when the socket is in raw mode and denotes the number of bytes to read. If Length is 0, all available bytes are returned. If Length > 0, exactly Length bytes are returned, or an error; except if the socket is closed from the other side, then the last read before the one returning {error, closed} may return less than Length bytes of data.

r_send_2

</>

pub fn r_send_2(
  socket socket: Socket,
  packet packet: Packet,
) -> Result(Nil, Dynamic)

send/2 Send a packet on a socket. Non-blocking send. When using inet_backend = socket, the behaviour is different. There is no buffering, instead the caller will “hang” until all of the data has been sent or the send timeout (as specified by the send_timeout option) expires (the function can “hang” even when using the inet backend if the internal buffers are full).

r_shutdown_2

</>

pub fn r_shutdown_2(
  socket socket: Socket,
  how how: ShutdownMethod,
) -> Result(Nil, Dynamic)

shutdown/2