about summary refs log tree commit diff stats
path: root/docs
diff options
context:
space:
mode:
authorFedor Indutny <fedor@indutny.com>2016-05-27 23:50:46 -0400
committerFedor Indutny <fedor@indutny.com>2016-05-27 23:50:46 -0400
commitd4069cc59b0c9d4ce00977a9268f90e306f1cdf8 (patch)
treeb4d35fb43555503db6566de9d0cf1cd71d6497f1 /docs
parent6a1f2335d96dfaf95a4423b94c36df389e3d4ec2 (diff)
downloaduv_link_t-d4069cc59b0c9d4ce00977a9268f90e306f1cdf8.tar.gz
api: inherit structs from uv_link_t
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
new file mode 100644
index 0000000..18e73c1
--- /dev/null
+++ b/docs/api.md
@@ -0,0 +1,44 @@
+# uv_link_t
+
+## Types
+
+### uv_link_t
+
+The base unit of all APIs. Pointer to this structure is what needs to be passed
+to the most of the methods.
+
+### uv_link_methods_t
+
+TODO(indutny)
+
+### uv_link_source_t
+
+TODO(indutny)
+
+### uv_link_observer_t
+
+TODO(indutny)
+
+## Methods
+
+### uv_link_t
+
+#### int uv_link_init(...)
+#### void uv_link_close(...)
+#### int uv_link_chain(...)
+#### int uv_link_unchain(...)
+#### void uv_link_propagate_alloc_cb(...)
+#### void uv_link_propagate_read_cb(...)
+#### int uv_link_propagate_write(...)
+#### int uv_link_propagate_shutdown(...)
+#### void uv_link_propagate_close(...)
+#### int uv_link_read_start(...)
+#### int uv_link_read_stop(...)
+#### int uv_link_write(...)
+#### int uv_link_try_write(...)
+#### int uv_link_shutdown(...)
+
+### uv_link_source_t
+
+#### int uv_link_source_init(...)
+#### int uv_link_observer_init(...)