diff options
author | Felix Lange <fjl@twurst.com> | 2016-07-15 04:53:33 +0800 |
---|---|---|
committer | Felix Lange <fjl@twurst.com> | 2016-07-15 05:03:40 +0800 |
commit | 74be4a62c53891016cc0bbd3f9b5ed5d0539efe4 (patch) | |
tree | e2659d1a7cd37b0497d7ad3280c27d925d9b586e /Godeps/_workspace/src/gopkg.in/natefinch/npipe.v2/doc.go | |
parent | e11489eb5f58a63cb39a3189de7263837dc95b93 (diff) | |
download | go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.tar go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.tar.gz go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.tar.bz2 go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.tar.lz go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.tar.xz go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.tar.zst go-tangerine-74be4a62c53891016cc0bbd3f9b5ed5d0539efe4.zip |
Godeps, rpc: switch back to package npipe
The named pipe implementation from go-winio has some issues
that need to be addressed before we can use it again.
Diffstat (limited to 'Godeps/_workspace/src/gopkg.in/natefinch/npipe.v2/doc.go')
-rw-r--r-- | Godeps/_workspace/src/gopkg.in/natefinch/npipe.v2/doc.go | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/Godeps/_workspace/src/gopkg.in/natefinch/npipe.v2/doc.go b/Godeps/_workspace/src/gopkg.in/natefinch/npipe.v2/doc.go new file mode 100644 index 000000000..3445773b4 --- /dev/null +++ b/Godeps/_workspace/src/gopkg.in/natefinch/npipe.v2/doc.go @@ -0,0 +1,50 @@ +// Copyright 2013 Nate Finch. All rights reserved. +// Use of this source code is governed by an MIT-style +// license that can be found in the LICENSE file. + +// Package npipe provides a pure Go wrapper around Windows named pipes. +// +// !! Note, this package is Windows-only. There is no code to compile on linux. +// +// Windows named pipe documentation: http://msdn.microsoft.com/en-us/library/windows/desktop/aa365780 +// +// Note that the code lives at https://github.com/natefinch/npipe (v2 branch) +// but should be imported as gopkg.in/natefinch/npipe.v2 (the package name is +// still npipe). +// +// npipe provides an interface based on stdlib's net package, with Dial, Listen, +// and Accept functions, as well as associated implementations of net.Conn and +// net.Listener. It supports rpc over the connection. +// +// Notes +// +// * Deadlines for reading/writing to the connection are only functional in Windows Vista/Server 2008 and above, due to limitations with the Windows API. +// +// * The pipes support byte mode only (no support for message mode) +// +// Examples +// +// The Dial function connects a client to a named pipe: +// conn, err := npipe.Dial(`\\.\pipe\mypipename`) +// if err != nil { +// <handle error> +// } +// fmt.Fprintf(conn, "Hi server!\n") +// msg, err := bufio.NewReader(conn).ReadString('\n') +// ... +// +// The Listen function creates servers: +// +// ln, err := npipe.Listen(`\\.\pipe\mypipename`) +// if err != nil { +// // handle error +// } +// for { +// conn, err := ln.Accept() +// if err != nil { +// // handle error +// continue +// } +// go handleConnection(conn) +// } +package npipe |