ptrProxy comments

Author: shazow

ptrproxy.go

@@ -6,6 +6,9 @@ import (
 	"unsafe"
 )
 
+// PtrProxy creates a safe pointer registry. It hangs on to an unsafe.Pointer and
+// returns a totally-safe C.uint ID that can be used to look up the original
+// pointer by using it.
 func PtrProxy() *ptrProxy {
 	return &ptrProxy{
 		lookup: map[uint]unsafe.Pointer{},
@@ -18,6 +21,8 @@ type ptrProxy struct {
 	lookup map[uint]unsafe.Pointer
 }
 
+// Ref registers the given pointer and returns a corresponding id that can be
+// used to retrieve it later.
 func (p *ptrProxy) Ref(ptr unsafe.Pointer) C.uint {
 	p.Lock()
 	id := p.count
@@ -27,13 +32,15 @@ func (p *ptrProxy) Ref(ptr unsafe.Pointer) C.uint {
 	return C.uint(id)
 }
 
+// Deref takes an id and returns the corresponding pointer if it exists.
 func (p *ptrProxy) Deref(id C.uint) (unsafe.Pointer, bool) {
 	p.Lock()
 	val, ok := p.lookup[uint(id)]
 	p.Unlock()
 	return val, ok
 }
 
+// Free releases a registered pointer by its id.
 func (p *ptrProxy) Free(id C.uint) {
 	p.Lock()
 	delete(p.lookup, uint(id))