xturn_sockets v0.1.0 Xirsys.Sockets.Conn View Source

Socket connection object for TURN

Link to this section Summary

Functions

Flags a connection object as halted, so it shouldn't be processed any further

If a response message has been set, then we must notify the client according to the STUN and TURN specifications.

Link to this section Types

Link to this type

t()

View Source
t() ::
  {listener :: :gen_tcp.socket() | :gen_udp.socket() | :ssl.sslsocket(),
   message :: binary(), decoded_message :: XMediaLib.Stun.t(),
   client_socket :: :gen_tcp.socket() | :gen_udp.socket() | :ssl.sslsocket(),
   client_ip :: tuple(), client_port :: integer(), server_ip :: tuple(),
   server_port :: integer(), is_control :: boolean(), force_auth :: boolean(),
   response :: Xirsys.Sockets.Response.t(), halt :: boolean()}

Link to this section Functions

Flags a connection object as halted, so it shouldn't be processed any further

Link to this function

response(conn, class, attrs \\ nil)

View Source
response(
  %Xirsys.Sockets.Conn{
    client_ip: term(),
    client_port: term(),
    client_socket: term(),
    decoded_message: term(),
    force_auth: term(),
    halt: term(),
    is_control: term(),
    listener: term(),
    message: term(),
    response: term(),
    server_ip: term(),
    server_port: term()
  },
  atom() | integer(),
  binary() | any()
) :: %Xirsys.Sockets.Conn{
  client_ip: term(),
  client_port: term(),
  client_socket: term(),
  decoded_message: term(),
  force_auth: term(),
  halt: term(),
  is_control: term(),
  listener: term(),
  message: term(),
  response: term(),
  server_ip: term(),
  server_port: term()
}
Link to this function

send(conn)

View Source
send(%Xirsys.Sockets.Conn{
  client_ip: term(),
  client_port: term(),
  client_socket: term(),
  decoded_message: term(),
  force_auth: term(),
  halt: term(),
  is_control: term(),
  listener: term(),
  message: term(),
  response: term(),
  server_ip: term(),
  server_port: term()
}) :: %Xirsys.Sockets.Conn{
  client_ip: term(),
  client_port: term(),
  client_socket: term(),
  decoded_message: term(),
  force_auth: term(),
  halt: term(),
  is_control: term(),
  listener: term(),
  message: term(),
  response: term(),
  server_ip: term(),
  server_port: term()
}

If a response message has been set, then we must notify the client according to the STUN and TURN specifications.