modulepackage
0.0.0-20191112112554-37d97cf40d03
Repository: https://github.com/docker/go-p9p.git
Documentation: pkg.go.dev
# README
p9p 
A modern, performant 9P library for Go.
For information on usage, please see the GoDoc.
Refer to 9P's documentation for more details on the protocol.
Copyright and license
Copyright © 2015 Docker, Inc. go-p9p is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
# Functions
DecodeDir decodes a directory entry from rd using the provided codec.
Dispatch returns a handler that dispatches messages to the target session.
EncodeDir writes the directory to wr.
GetVersion returns the protocol version from the context.
NewChannel returns a new channel to read and write Fcalls with the provided connection and message size.
NewCodec returns a new, standard 9P2000 codec, ready for use.
NewFixedReaddir returns a Readdir that will returned a fixed set of directory entries.
NewReaddir returns a new Readdir to assist implementing server-side Readdir.
NewSession returns a session using the connection.
Overflow will return a positive number, indicating there was an overflow for the error.
ReaddirAll reads all the directory entries for the resource fid.
ServeConn the 9p handler over the provided network connection.
# Constants
DefaultMSize messages size used to establish a session.
DefaultVersion for this package.
mode bit for append only files.
mode bit for authentication file.
Mode constants for use Dir.Mode.
mode bit for directories.
mode bit for exclusive use files.
mode bit for execute permission.
mode bit for mounted channel.
Mode constants for use Dir.Mode.
mode bit for read permission.
Mode constants for use Dir.Mode.
Mode constants for use Dir.Mode.
Mode constants for use Dir.Mode.
Mode constants for use Dir.Mode.
mode bit for non-backed-up files.
mode bit for write permission.
NOFID indicates the lack of an Fid.
NOTAG is a reserved values for messages sent before establishing a session, such as Tversion.
or'ed in, close on exec.
execute, == read but check execute permission.
or'ed in, remove on close.
read and write.
open for read.
Constants to use when opening files.
or'ed in (except for exec), truncate file first.
write.
type bit for append only files.
type bit for authentication file.
type bit for directories.
type bit for exclusive use files.
plain file.
type bit for mounted channel.
type bit for not-backed-up file.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
Definitions for Fcall's used in 9P2000.
# Variables
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
returned when timing out on the fcall.
returned when an unexpected message is encountered.
9p wire errors returned by Session interface methods.
returned when encountering unknown message type.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
9p wire errors returned by Session interface methods.
# Structs
Dir defines the structure used for expressing resources in stat/wstat and when reading directories.
Fcall defines the fields for sending a 9p formatted message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MessageRerror provides both a Go error type and message type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MessageVersion encodes the message body for Tversion and Rversion RPC calls.
No description provided by the author
No description provided by the author
No description provided by the author
Qid indicates the type, path and version of the resource returned by a server.
Readdir helps one to implement the server-side of Session.Read on directories.
# Interfaces
Channel defines the operations necessary to implement a 9p message channel interface.
Codec defines the interface for encoding and decoding of 9p types.
Handler defines an interface for 9p message handlers.
Message represents the target of an fcall.
Session provides the central abstraction for a 9p connection.
# Type aliases
FcallType encodes the message type for the target Fcall.
Fid defines a type to hold Fid values.
Flag defines the flag type for use with open and create.
HandlerFunc is a convenience type for defining inline handlers.
QType indicates the type of a resource within the Qid.
Tag uniquely identifies an outstanding fcall in a 9p session.