]> Cypherpunks repositories - gostls13.git/commitdiff
Document runtime functions.
authorRob Pike <r@golang.org>
Fri, 8 May 2009 22:55:45 +0000 (15:55 -0700)
committerRob Pike <r@golang.org>
Fri, 8 May 2009 22:55:45 +0000 (15:55 -0700)
R=rsc
DELTA=25  (25 added, 0 deleted, 0 changed)
OCL=28574
CL=28580

src/lib/runtime/runtime.go [new file with mode: 0644]

diff --git a/src/lib/runtime/runtime.go b/src/lib/runtime/runtime.go
new file mode 100644 (file)
index 0000000..e3cf54c
--- /dev/null
@@ -0,0 +1,26 @@
+// Copyright 2009 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+       The runtime package contains operations that interact with Go's runtime system,
+       such as functions to control goroutines.
+ */
+package runtime
+
+// Gosched yields the processor, allowing other goroutines to run.  It does not
+// suspend the current goroutine, so execution resumes automatically.
+func   Gosched()
+
+// Goexit terminates the goroutine that calls it.  No other goroutine is affected.
+func   Goexit()
+
+// Breakpoint() executes a breakpoint trap.
+func   Breakpoint()
+
+// Caller reports file and line number information about function invocations on
+// the calling goroutine's stack.  The argument is the number of stack frames to
+// ascend, with 1 identifying the the caller of Caller.  The return values report the
+// program counter, file name, and line number within the file of the corresponding
+// call.  The boolean ok is false if it was not possible to recover the information.
+func   Caller(n int) (pc uint64, file string, line int, ok bool)