more desired api
This commit is contained in:
Ryan Dahl
parent
5be0fe2168
commit
ee712eba36
@ -24,10 +24,8 @@ common:
|
||||
A TCP server class that is a subclass of `uv_handle_t`. This can be bound to
|
||||
an address and begin accepting new TCP sockets.
|
||||
|
||||
|
||||
`int uv_bind4(uv_tcp_server_t* tcp_server, struct sockaddr_in* address);`
|
||||
|
||||
`int uv_bind6(uv_tcp_server_t* tcp_server, struct sockaddr_in6* address);`
|
||||
int uv_bind4(uv_tcp_server_t* tcp_server, struct sockaddr_in* address);
|
||||
int uv_bind6(uv_tcp_server_t* tcp_server, struct sockaddr_in6* address);
|
||||
|
||||
Binds the TCP server to an address. The `address` can be created with
|
||||
`uv_ip4_addr()`. Call this before `uv_listen()`
|
||||
@ -44,14 +42,38 @@ Returns zero on success, -1 on failure. Errors in order of least-seriousness:
|
||||
* `UV_EFAULT` Memory of `address` parameter is unintelligible.
|
||||
|
||||
|
||||
int uv_listen(uv_tcp_server_t*, int backlog, uv_accept_cb cb);
|
||||
|
||||
Begins listening for connections. The accept callback is level-triggered.
|
||||
|
||||
|
||||
int uv_accept(uv_tcp_server_t* server,
|
||||
uv_tcp_t* client,
|
||||
uv_close_cb close_cb,
|
||||
void* data);
|
||||
|
||||
Accepts a connection. This should be called after the accept callback is
|
||||
made. The `client` parameter should be uninitialized memory; `uv_accept` is
|
||||
used instead of `uv_tcp_init` for server-side `uv_tcp_t` initialization.
|
||||
|
||||
Return value 0 indicates success, -1 failure. Possible errors:
|
||||
|
||||
* `UV_EAGAIN` There are no connections. Wait for the `uv_accept_cb` callback
|
||||
to be called again.
|
||||
|
||||
* `UV_EFAULT` The memory of either `server` is unintelligible.
|
||||
|
||||
|
||||
|
||||
# `uv_stream_t`
|
||||
|
||||
An abstract subclass of `uv_handle_t`. Streams represent something that
|
||||
reads and/or writes data. Streams can be half or full-duplex. TCP sockets
|
||||
are streams, files are streams with offsets.
|
||||
|
||||
|
||||
`int uv_read_start(uv_stream_t* stream, uv_alloc_cb alloc_cb, uv_read_cb read_cb);`
|
||||
int uv_read_start(uv_stream_t* stream,
|
||||
uv_alloc_cb alloc_cb,
|
||||
uv_read_cb read_cb);
|
||||
|
||||
Starts the stream reading continuously. The `alloc_cb` is used to allow the
|
||||
user to implement various means of supplying the stream with buffers to
|
||||
@ -62,17 +84,20 @@ not indicate EOF as in other systems. EOF is made via the `uv_eof_cb` which
|
||||
can be set like this `uv_set_eof_cb(stream, eof_cb);`
|
||||
|
||||
|
||||
`int uv_read_stop(uv_stream_t* stream);`
|
||||
int uv_read_stop(uv_stream_t* stream);
|
||||
|
||||
Stops reading from the stream.
|
||||
|
||||
|
||||
`int uv_write_req_init(uv_write_req_t*, uv_stream_t*, uv_buf_t bufs[], int butcnf);`
|
||||
int uv_write_req_init(uv_write_req_t*,
|
||||
uv_stream_t*,
|
||||
uv_buf_t bufs[],
|
||||
int butcnf,
|
||||
uv_close_cb close_cb,
|
||||
void* data);
|
||||
|
||||
Initiates a write request on a stream.
|
||||
|
||||
|
||||
`int uv_shutdown_req_init(uv_shutdown_req_t*, uv_stream_t*)`
|
||||
int uv_shutdown_req_init(uv_shutdown_req_t*, uv_stream_t*)
|
||||
|
||||
Initiates a shutdown of outgoing data once the write queue drains.
|
||||
|
||||
@ -80,11 +105,19 @@ Initiates a shutdown of outgoing data once the write queue drains.
|
||||
|
||||
# `uv_tcp_t`
|
||||
|
||||
The TCP handle class abstracts one endpoint of a duplex TCP stream or a
|
||||
listening socket. `uv_tcp_t` is a subclass of `uv_stream_t`.
|
||||
The TCP handle class represents one endpoint of a duplex TCP stream.
|
||||
`uv_tcp_t` is a subclass of `uv_stream_t`. A TCP handle can represent a
|
||||
client side connection (one that has been used with uv_connect_req_init`)
|
||||
or a server-side connection (one that was initialized with `uv_accept`)
|
||||
|
||||
int uv_connect_req_init(uv_connect_req_t* req,
|
||||
uv_tcp_t* socket,
|
||||
struct sockaddr* addr,
|
||||
uv_close_cb close_cb,
|
||||
void* data);
|
||||
|
||||
Initiates a request to open a connection.
|
||||
|
||||
TCP stream's fundamental operations are reading and writing data.
|
||||
Additionally duplex TCP streams can be half-closed.
|
||||
|
||||
|
||||
# `uv_req_t`
|
||||
@ -98,10 +131,41 @@ Subclass of `uv_req_t`. Represents a request for a TCP connection. Operates
|
||||
on `uv_tcp_t` handles. Like other types of requests the `close_cb` indicates
|
||||
completion of the request.
|
||||
|
||||
`int uv_connect_req_init(uv_connect_req_t* req, uv_tcp_t* socket, struct sockaddr* addr, uv_close_cb close_cb, void* data);`
|
||||
int uv_connect_req_init(uv_connect_req_t* req,
|
||||
uv_tcp_t* socket,
|
||||
struct sockaddr* addr,
|
||||
uv_close_cb close_cb,
|
||||
void* data);
|
||||
|
||||
Initializes the connection request. Returning 0 indicates success, -1 if
|
||||
there was an error. The following values can be retrieved from
|
||||
`uv_last_error` in the case of an error:
|
||||
|
||||
* ???
|
||||
|
||||
|
||||
# `uv_shutdown_req_t`
|
||||
|
||||
Subclass of `uv_req_t`. Represents an ongoing shutdown request. Once the
|
||||
write queue of the parent `uv_stream_t` is drained, the outbound data
|
||||
channel is shutdown. Once a shutdown request is initiated on a stream, the
|
||||
stream will allow no more writes.
|
||||
|
||||
int uv_shutdown_req_init(uv_shutdown_req_t*,
|
||||
uv_stream_t* parent,
|
||||
uv_close_cb close_cb,
|
||||
void* data);
|
||||
|
||||
Initializes the shutdown request.
|
||||
|
||||
|
||||
# `uv_write_req_t`
|
||||
|
||||
int uv_write_req_init(uv_write_req_t*,
|
||||
uv_stream_t*,
|
||||
uv_buf_t bufs[],
|
||||
int butcnf,
|
||||
uv_close_cb close_cb,
|
||||
void* data);
|
||||
|
||||
Initiates a write request on a stream.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user