| Portability | Only tested on GHC 6.12.1, uses TypeSynonnymInstances |
|---|---|
| Stability | experimental |
| Maintainer | David Leimbach <leimy2k@gmail.com> |
Data.NineP
Contents
Description
Binary serialization of 9P messages to and from lazy ByteStrings. This library does not currently provide any networking support or wrappers for easy to write clients or servers, though that may come with time as we decide the best way to implement these.
Perhaps interesting about 9P is that the messages are send in little endian as opposed to the somewhat misnamed network byte order that most people refer to for big endian.
It's fairly easy to use runPut or runGet to generate or parse 9P messages example:
send sock $ runPut (put (Msg TTVersion (-1) & Tversion 1024 9P2000))
This sends a lazy ByteString over a socket to begin a handshake of a 9P connection with a server, negotiating the use of the 9P2000 protocol, with a maximum message size of 1KB, using a tag of (-1) (known as NOTAG in 9P space.
This 9P implementation has been lightly tested against an Inferno operating system share with no authentication successfully.
- class Bin a where
- data Qid = Qid {}
- data Stat = Stat {}
- data Msg = Msg {}
- data Tag
- data VarMsg
- = Tversion {
- tv_msize :: Word32
- tv_version :: String
- | Rversion {
- rv_msize :: Word32
- rv_version :: String
- | Tauth { }
- | Rauth { }
- | Rerror { }
- | Tflush { }
- | Rflush
- | Tattach { }
- | Rattach { }
- | Twalk { }
- | Rwalk { }
- | Topen { }
- | Ropen { }
- | Tcreate { }
- | Rcreate {
- rcr_qid :: Qid
- rcr_iounit :: Word32
- | Tread { }
- | Rread { }
- | Twrite {
- twr_fid :: Word32
- twr_offset :: Word64
- twr_dat :: ByteString
- | Rwrite { }
- | Tclunk { }
- | Rclunk
- | Tremove { }
- | Rremove
- | Tstat { }
- | Rstat { }
- | Twstat { }
- | Rwstat
- = Tversion {
Bin is the little endian encode/decode class for 9P2000
The Qid class (http:9p.cat-v.org for details)
A Plan 9 Qid type. See http:9p.cat-v.org for more information
like stat for unix filesystems, but for 9P2000
Provides information on a path entry at a 9P2000 server
Constructors
| Stat | |
The Msg type is an enveleope for 9P2000 messages
The message envelope type for all 9P2000 messages
Tag is the (possibly misnamed) message payload type
A type that enumerates all the valid (and one invalid) message types in 9P2000
VarMsg is an algebraic type allowing for the various types of messages 9P2000 can have to be grouped under one type
A variable message type that encapsulates the valid kinds of messages in a 9P2000 payload
Constructors
| Tversion | |
Fields
| |
| Rversion | |
Fields
| |
| Tauth | |
| Rauth | |
| Rerror | |
| Tflush | |
| Rflush | |
| Tattach | |
| Rattach | |
| Twalk | |
| Rwalk | |
| Topen | |
| Ropen | |
| Tcreate | |
| Rcreate | |
Fields
| |
| Tread | |
| Rread | |
Fields | |
| Twrite | |
Fields
| |
| Rwrite | |
| Tclunk | |
| Rclunk | |
| Tremove | |
| Rremove | |
| Tstat | |
| Rstat | |
| Twstat | |
| Rwstat | |