about summary refs log tree commit diff stats
path: root/docs
diff options
context:
space:
mode:
authorFedor Indutny <fedor@indutny.com>2016-06-04 14:37:26 -0400
committerFedor Indutny <fedor@indutny.com>2016-06-04 14:37:26 -0400
commit0799c7c91ee710eb9ce752bcfcd6952a0838b495 (patch)
tree95438536ddd04497de650d99196eada0d822e255 /docs
parentc5e93b2077a6ea27b4af440cfe4938d7bc093c2f (diff)
downloaduv_link_t-0799c7c91ee710eb9ce752bcfcd6952a0838b495.tar.gz
api: `uv_link_strerror`
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index 2d2877b..b73a428 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -118,6 +118,16 @@ Invoke `shutdown` from the link's [`uv_link_methods_t`][]. Acts similarly to
 `uv_shutdown()`. `cb(uv_link_t* link, int status, void* arg)` is invoked on
 completion.
 
+### const char* uv_link_strerror(...)
+
+* `uv_link_t* link`
+* `int err` - error code, previously either returned the one of the
+  `uv_link...` methods or passed as a negative `nread` to `link->read_cb`
+
+Invoke `strerror` from the link's [`uv_link_methods_t`][]. Acts similarly to
+`uv_strerror()`. Returns a description of error code that has just been given
+back to the user.
+
 ### void uv_link_propagate_alloc_cb(...)
 
 Should be used only by [`uv_link_methods_t`][] implementation.
@@ -385,6 +395,19 @@ is passed only only for internal operation.
 
 *NOTE: semantics are the same as of `uv_close`.*
 
+### .strerror
+
+```c
+const char* (*strerror)(uv_link_t* link, int err);
+```
+
+Invoked by [`uv_link_strerror()`][].
+
+Should return a description string of the `err`, or propagate call to the
+`link->parent` if the error wasn't emitted by the current `link`.
+
+*NOTE: semantics are the same as of `uv_strerror`.*
+
 ### .alloc_cb_override
 
 A method used to override that value of [`uv_link_t.alloc_cb`][] by
@@ -468,6 +491,7 @@ Invoked by `uv_link_propagate_read_cb`. MUST not manage the data in `buf`.
 
 [`uv_link_chain()`]: #int-uv_link_chain
 [`uv_link_close()`]: #void-uv_link_close
+[`uv_link_strerror()`]: #const-char-uv_link_strerror
 [`uv_link_init()`]: #int-uv_link_init
 [`uv_link_methods_t`]: #uv_link_methods_t
 [`uv_link_observer_t.observer_read_cb`]: #observer_read_cb