package async_unix
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=a6a86202acea433b5c739ac20190a9a364da9d9eb7ebd402f517b8c58983839b
doc/async_unix/Async_unix/Socket/index.html
Module Async_unix.SocketSource
type (+'a, 'b) t
constraint 'a = [< `Unconnected | `Bound | `Passive | `Active ]
constraint 'b = [< Address.t ]Sockets have a phantom type parameter that tracks the state of the socket in order to eliminate certain errors in which socket functions are called in the wrong order. Initially, a socket is `Unconnected. As various socket functions are called, they return a socket with a new phantom state. Here is a chart of the allowed state transitions.
Unconnected ---connect--> Active
|
| ---bind--> Bound ---listen--> Passive ---accept---> Active
|
| ---connect--> Activeval sexp_of_t :
('a -> Sexplib0.Sexp.t) ->
('b -> Sexplib0.Sexp.t) ->
('a, 'b) t ->
Sexplib0.Sexp.tval connect :
([< `Unconnected | `Bound ], 'addr) t ->
'addr ->
([ `Active ], 'addr) t Async_kernel.Deferred.tCalling Fd.close on the socket's file descriptor before or during connect may cause connect to raise.
val connect_interruptible :
([< `Unconnected | `Bound ], 'addr) t ->
'addr ->
interrupt:unit Async_kernel.Deferred.t ->
[ `Ok of ([ `Active ], 'addr) t | `Interrupted ] Async_kernel.Deferred.tval bind_keep_opts :
([ `Unconnected ], 'addr) t ->
'addr ->
([ `Bound ], 'addr) t Async_kernel.Deferred.tLike bind, but preserves the existing socket options and the CLOEXEC flag.
val bind :
?reuseaddr:bool ->
([ `Unconnected ], 'addr) t ->
'addr ->
([ `Bound ], 'addr) t Async_kernel.Deferred.tbind socket addr sets close_on_exec for the fd of socket.
val bind_inet_keep_opts :
([ `Unconnected ], Address.Inet.t) t ->
Address.Inet.t ->
([ `Bound ], Address.Inet.t) tLike bind_inet, but preserves the existing socket options and the CLOEXEC flag.
val bind_inet :
?reuseaddr:bool ->
([ `Unconnected ], Address.Inet.t) t ->
Address.Inet.t ->
([ `Bound ], Address.Inet.t) tbind_inet socket addr is just like bind but is restricted to Inet.t addresses and is therefore guaranteed not to block.
val accept :
([ `Passive ], 'addr) t ->
[ `Ok of ([ `Active ], 'addr) t * 'addr | `Socket_closed ]
Async_kernel.Deferred.tval accept_interruptible :
([ `Passive ], 'addr) t ->
interrupt:unit Async_kernel.Deferred.t ->
[ `Ok of ([ `Active ], 'addr) t * 'addr | `Socket_closed | `Interrupted ]
Async_kernel.Deferred.tval accept_at_most :
([ `Passive ], 'addr) t ->
limit:int ->
[ `Ok of (([ `Active ], 'addr) t * 'addr) list | `Socket_closed ]
Async_kernel.Deferred.taccept_at_most is like accept, but will return up to limit connections before yielding, where limit >= 1. accept_at_most first waits for one connection and then attempts to retrieve up to limit connections through non-blocking Unix.accept calls. If a call to Unix.accept would block before limit is reached, accept_at_most returns the connections retrieved thus far.
Servers that must service a large number of connections tend to observe a stall in connection accept rates when under heavy load. Increasing limit will ameliorate this effect, and increase accept rates and overall throughput of the server at the cost of increased contention for resources amongst connections.
For details, see:
Acceptable strategies for improving web server performance Brecht, Pariag, and Gammo. USENIX ATEC '04
val accept_at_most_interruptible :
([ `Passive ], 'addr) t ->
limit:int ->
interrupt:unit Async_kernel.Deferred.t ->
[ `Ok of (([ `Active ], 'addr) t * 'addr) list
| `Socket_closed
| `Interrupted ]
Async_kernel.Deferred.tval bind_to_interface_exn :
(([ `Unconnected ], Address.t) t ->
Linux_ext.Bound_to_interface.t ->
unit)
Core.Or_error.tbind_to_interface_exn t (`Interface_name "eth0") restricts messages from being received or sent on interfaces other than eth0. See Linux_ext.bind_to_interface.
Typically, one would use this function for very specific non-multicast requirements. For similar functionality when using multicast, see Core_unix.mcast_set_ifname.