aboutsummaryrefslogtreecommitdiff
path: root/v_windows/v/vlib/context/README.md
diff options
context:
space:
mode:
authorIndrajith K L2022-12-03 17:00:20 +0530
committerIndrajith K L2022-12-03 17:00:20 +0530
commitf5c4671bfbad96bf346bd7e9a21fc4317b4959df (patch)
tree2764fc62da58f2ba8da7ed341643fc359873142f /v_windows/v/vlib/context/README.md
downloadcli-tools-windows-master.tar.gz
cli-tools-windows-master.tar.bz2
cli-tools-windows-master.zip
Adds most of the toolsHEADmaster
Diffstat (limited to 'v_windows/v/vlib/context/README.md')
-rw-r--r--v_windows/v/vlib/context/README.md166
1 files changed, 166 insertions, 0 deletions
diff --git a/v_windows/v/vlib/context/README.md b/v_windows/v/vlib/context/README.md
new file mode 100644
index 0000000..7fbf18b
--- /dev/null
+++ b/v_windows/v/vlib/context/README.md
@@ -0,0 +1,166 @@
+# Context
+
+This module defines the Context type, which carries deadlines, cancellation signals,
+and other request-scoped values across API boundaries and between processes.
+
+Incoming requests to a server should create a Context, and outgoing calls to servers
+should accept a Context. The chain of function calls between them must propagate the
+Context, optionally replacing it with a derived Context created using with_cancel,
+with_deadline, with_timeout, or with_value. When a Context is canceled, all Contexts
+derived from it are also canceled.
+
+The with_cancel, with_deadline, and with_timeout functions take a Context (the parent)
+and return a derived Context (the child). Calling the cancel function
+cancels the child and its children, removes the parent's reference to the child,
+and stops any associated timers.
+
+Programs that use Contexts should follow these rules to keep interfaces consistent
+across different modules.
+
+Do not store Contexts inside a struct type; instead, pass a Context explicitly
+to each function that needs it. The Context should be the first parameter,
+typically named ctx, just to make it more consistent.
+
+## Examples
+
+In this section you can see some usage examples for this module
+
+### Context With Cancellation
+
+```v
+import context
+
+// This example demonstrates the use of a cancelable context to prevent a
+// routine leak. By the end of the example function, the routine started
+// by gen will return without leaking.
+fn example_with_cancel() {
+ // gen generates integers in a separate routine and
+ // sends them to the returned channel.
+ // The callers of gen need to cancel the context once
+ // they are done consuming generated integers not to leak
+ // the internal routine started by gen.
+ gen := fn (ctx context.Context) chan int {
+ dst := chan int{}
+ go fn (ctx context.Context, dst chan int) {
+ mut v := 0
+ ch := ctx.done()
+ for {
+ select {
+ _ := <-ch {
+ // returning not to leak the routine
+ return
+ }
+ dst <- v {
+ v++
+ }
+ }
+ }
+ }(ctx, dst)
+ return dst
+ }
+
+ ctx := context.with_cancel(context.background())
+ defer {
+ context.cancel(ctx)
+ }
+
+ ch := gen(ctx)
+ for i in 0 .. 5 {
+ v := <-ch
+ assert i == v
+ }
+}
+```
+
+### Context With Deadline
+
+```v
+import context
+import time
+
+const (
+ // a reasonable duration to block in an example
+ short_duration = 1 * time.millisecond
+)
+
+// This example passes a context with an arbitrary deadline to tell a blocking
+// function that it should abandon its work as soon as it gets to it.
+fn example_with_deadline() {
+ dur := time.now().add(short_duration)
+ ctx := context.with_deadline(context.background(), dur)
+
+ defer {
+ // Even though ctx will be expired, it is good practice to call its
+ // cancellation function in any case. Failure to do so may keep the
+ // context and its parent alive longer than necessary.
+ context.cancel(ctx)
+ }
+
+ ctx_ch := ctx.done()
+ select {
+ _ := <-ctx_ch {}
+ 1 * time.second {
+ panic('This should not happen')
+ }
+ }
+}
+```
+
+### Context With Timeout
+
+```v
+import context
+import time
+
+const (
+ // a reasonable duration to block in an example
+ short_duration = 1 * time.millisecond
+)
+
+// This example passes a context with a timeout to tell a blocking function that
+// it should abandon its work after the timeout elapses.
+fn example_with_timeout() {
+ // Pass a context with a timeout to tell a blocking function that it
+ // should abandon its work after the timeout elapses.
+ ctx := context.with_timeout(context.background(), short_duration)
+ defer {
+ context.cancel(ctx)
+ }
+
+ ctx_ch := ctx.done()
+ select {
+ _ := <-ctx_ch {}
+ 1 * time.second {
+ panic('This should not happen')
+ }
+ }
+}
+```
+
+### Context With Value
+
+```v
+import context
+
+type ValueContextKey = string
+
+// This example demonstrates how a value can be passed to the context
+// and also how to retrieve it if it exists.
+fn example_with_value() {
+ f := fn (ctx context.Context, key ValueContextKey) string {
+ if value := ctx.value(key) {
+ if !isnil(value) {
+ return *(&string(value))
+ }
+ }
+ return 'key not found'
+ }
+
+ key := ValueContextKey('language')
+ value := 'VAL'
+ ctx := context.with_value(context.background(), key, &value)
+
+ assert value == f(ctx, key)
+ assert 'key not found' == f(ctx, ValueContextKey('color'))
+}
+```