Socket.Protocol protocol (socket2 v2.1.2)

Summary

Types

t()

All the types that implement this protocol.

Functions

accept(self, options \\ [])

Accept a connection from the socket.

active(self)

Make the socket active.

active(self, mode)

Make the socket active once.

close(self)

Close the socket.

equal?(self, other)

Check the two sockets are the same.

local(self)

Get the local address/port of the socket.

options(self, opts)

Set options for the socket.

packet(self, type)

Change the packet type of the socket.

passive(self)

Make the socket passive.

process(self, pid)

Change the controlling process of the socket.

remote(self)

Get the remote address/port of the socket.

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

accept(self, options \\ [])

@spec accept(t(), Keyword.t()) :: {:ok, t()} | {:error, term()}

Accept a connection from the socket.

active(self)

@spec active(t()) :: :ok | {:error, term()}

Make the socket active.

active(self, mode)

@spec active(t(), :once) :: :ok | {:error, term()}

Make the socket active once.

close(self)

@spec close(t()) :: :ok | {:error, term()}

Close the socket.

equal?(self, other)

@spec equal?(t(), t()) :: boolean()

Check the two sockets are the same.

local(self)

@spec local(t()) ::
  {:ok, {Socket.Address.t(), :inet.port_number()}} | {:error, term()}

Get the local address/port of the socket.

options(self, opts)

@spec options(t(), Keyword.t()) :: :ok | {:error, term()}

Set options for the socket.

packet(self, type)

@spec packet(t(), atom()) :: :ok | {:error, term()}

Change the packet type of the socket.

passive(self)

@spec passive(t()) :: :ok | {:error, term()}

Make the socket passive.

process(self, pid)

@spec process(t(), pid()) :: :ok | {:error, term()}

Change the controlling process of the socket.

remote(self)

@spec remote(t()) ::
  {:ok, {Socket.Address.t(), :inet.port_number()}} | {:error, term()}

Get the remote address/port of the socket.