socket

v0.3.13

socket v0.3.13 Socket

Link to this section Summary

Types

t()

Functions

accept(self)
accept(self, options)
accept!(self)
accept!(self, options)
active(self)
active(self, mode)
active!(self)
active!(self, mode)
close(self)
close!(self)
connect(uri)

Create a socket connecting to somewhere using an URI

connect!(uri)

Create a socket connecting to somewhere using an URI, raising if an error occurs, see connect

equal?(self, other)
listen(uri)

Create a socket listening somewhere using an URI

listen!(uri)

Create a socket listening somewhere using an URI, raising if an error occurs, see listen

local(self)
local!(self)
options(self, opts)
options!(self, opts)
packet(self, type)
packet!(self, type)
passive(self)
passive!(self)
process(self, pid)
process!(self, pid)
remote(self)
remote!(self)

Link to this section Types

Link to this section Functions

Link to this function accept(self, options)
Link to this function accept!(self, options)
Link to this function active(self, mode)
Link to this function active!(self, mode)
Link to this function connect(uri) 
connect(String.t() | URI.t()) :: {:ok, Socket.t()} | {:error, any()}

Create a socket connecting to somewhere using an URI.

Supported URIs

  • tcp://host:port for Socket.TCP
  • ssl://host:port for Socket.SSL
  • ws://host:port/path for Socket.Web (using Socket.TCP)
  • wss://host:port/path for Socket.Web (using Socket.SSL)
  • udp://host:port for Socket:UDP

Example 

{ :ok, client } = Socket.connect "tcp://google.com:80"
client.send "GET / HTTP/1.1\r\n"
client.recv
Link to this function connect!(uri) 
connect!(String.t() | URI.t()) :: Socket.t() | no_return()

Create a socket connecting to somewhere using an URI, raising if an error occurs, see connect.

Link to this function equal?(self, other)
Link to this function listen(uri) 
listen(String.t() | URI.t()) :: {:ok, Socket.t()} | {:error, any()}

Create a socket listening somewhere using an URI.

Supported URIs

If host is * it will be converted to 0.0.0.0.

  • tcp://host:port for Socket.TCP
  • ssl://host:port for Socket.SSL
  • ws://host:port/path for Socket.Web (using Socket.TCP)
  • wss://host:port/path for Socket.Web (using Socket.SSL)
  • udp://host:port for Socket:UDP

Example 

{ :ok, server } = Socket.listen "tcp://*:1337"
client = server |> Socket.accept!(packet: :line)
client |> Socket.Stream.send(client.recv)
client |> Socket.Stream.close
Link to this function listen!(uri) 
listen!(String.t() | URI.t()) :: Socket.t() | no_return()

Create a socket listening somewhere using an URI, raising if an error occurs, see listen.

Link to this function options(self, opts)
Link to this function options!(self, opts)
Link to this function packet(self, type)
Link to this function packet!(self, type)
Link to this function process(self, pid)
Link to this function process!(self, pid)