GSMLG.Socket v0.1.0

GSMLG.Socket.Protocol protocol (GSMLG.Socket v0.1.0)

Link to this section Summary

Types

t()

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.

Link to this section Types

Link to this type

t()

@type t() :: term()

Link to this section Functions

Link to this function

accept(self, options \\ [])

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

Accept a connection from the socket.

Link to this function

active(self)

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

Make the socket active.

Link to this function

active(self, mode)

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

Make the socket active once.

Link to this function

close(self)

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

Close the socket.

Link to this function

equal?(self, other)

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

Check the two sockets are the same.

Link to this function

local(self)

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

Get the local address/port of the socket.

Link to this function

options(self, opts)

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

Set options for the socket.

Link to this function

packet(self, type)

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

Change the packet type of the socket.

Link to this function

passive(self)

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

Make the socket passive.

Link to this function

process(self, pid)

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

Change the controlling process of the socket.

Link to this function

remote(self)

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

Get the remote address/port of the socket.