Documentation
¶
Index ¶
- Constants
- func Dial(path string) (net.Conn, error)
- func DialContext(x context.Context, path string) (net.Conn, error)
- func DialTimeout(path string, t time.Duration) (net.Conn, error)
- func Format(s string) string
- func Listen(path string) (net.Listener, error)
- func ListenPerms(path, perms string) (net.Listener, error)
- type Piper
Constants ¶
const PermEveryone = "0766"
PermEveryone is the Linux permission string used in sockets to allow anyone to write and read to the listening socket. This can be used for socket communcation between privilege boundaries. This can be applied to the ListenPerm function.
const Pipe = Piper(time.Second * 15)
Pipe is the default Connector with the default timeout of 15 seconds.
Variables ¶
This section is empty.
Functions ¶
func Dial ¶
Dial connects to the specified Pipe path. This function will return a net.Conn instance or any errors that may occur during the connection attempt. Pipe names are in the form of "/<path>". This function blocks indefinitely. Use the DialTimeout or DialContext to specify a control method.
func DialContext ¶
DialContext connects to the specified Pipe path. This function will return a net.Conn instance or any errors that may occur during the connection attempt. Pipe names are in the form of "/<path>. This function blocks until the supplied context is cancled and will return the context's Err() if the cancel occurs before the connection.
func DialTimeout ¶
DialTimeout connects to the specified Pipe path. This function will return a net.Conn instance or any errors that may occur during the connection attempt. Pipe names are in the form of "/<path>". This function blocks for the specified amount of time and will return 'Errtimeout' if the timeout is reached.
func Format ¶
Format will ensure the path for this Pipe socket fits the proper OS based pathname. Valid pathnames will be returned without any changes.
func Listen ¶
Listen returns a net.Listener that will listen for new connections on the Named Pipe path specified or any errors that may occur during listener creation. Pipe names are in the form of "/<path>".
func ListenPerms ¶
ListenPerms returns a net.Listener that will listen for new connections on the Named Pipe path specified or any errors that may occur during listener creation. Pipe names are in the form of "/<path>". This function allows for specifying a SDDL string used to set the permissions of the listeneing Pipe.
Source Files