Skip to content

Latest commit

 

History

History
111 lines (50 loc) · 3.46 KB

hackney_tcp_transport.md

File metadata and controls

111 lines (50 loc) · 3.46 KB

#Module hackney_tcp_transport#

##Function Index##

close/1Close a TCP socket.
connect/3
controlling_process/2Assign a new controlling process Pid to Socket.
peername/1Return the address and port for the other end of a connection.
recv/2
recv/3Receive a packet from a socket in passive mode.
send/2Send a packet on a socket.
setopts/2Set one or more options for a socket.
sockname/1Get the local address and port of a socket.

##Function Details##

###close/1##

close(Socket::inet:socket()) -> ok



Close a TCP socket.

See also: gen_tcp:close/1.

###connect/3##

connect(Host, Port, Opts) -> any()

###controlling_process/2##

controlling_process(Socket::inet:socket(), Pid::pid()) -> ok | {error, closed | not_owner | atom()}



Assign a new controlling process Pid to Socket.

See also: gen_tcp:controlling_process/2.

###peername/1##

peername(Socket::inet:socket()) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, atom()}



Return the address and port for the other end of a connection.

See also: inet:peername/1.

###recv/2##

recv(Socket, Length) -> any()

###recv/3##

recv(Socket::inet:socket(), Length::non_neg_integer(), Timeout::timeout()) -> {ok, any()} | {error, closed | atom()}



Receive a packet from a socket in passive mode.

See also: gen_tcp:recv/3.

###send/2##

send(Socket::inet:socket(), Packet::iolist()) -> ok | {error, atom()}



Send a packet on a socket.

See also: gen_tcp:send/2.

###setopts/2##

setopts(Socket::inet:socket(), Opts::list()) -> ok | {error, atom()}



Set one or more options for a socket.

See also: inet:setopts/2.

###sockname/1##

sockname(Socket::inet:socket()) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, atom()}



Get the local address and port of a socket

See also: inet:sockname/1.