Network.Starling.Core
Description
Primitives for the memcached protocol.
- data Request
- requestOp :: Request -> OpCode
- type Key = ByteString
- type Value = ByteString
- set :: Key -> Value -> Request
- add :: Key -> Value -> Request
- replace :: Key -> Value -> Request
- get :: Key -> Request
- increment :: Key -> Word64 -> Word64 -> Request
- decrement :: Key -> Word64 -> Word64 -> Request
- append :: Key -> Value -> Request
- prepend :: Key -> Value -> Request
- delete :: Key -> Request
- quit :: Request
- flush :: Request
- noop :: Request
- version :: Request
- stat :: Maybe Key -> Request
- listAuthMechanisms :: Request
- startAuth :: AuthMechanism -> AuthData -> Request
- stepAuth :: AuthMechanism -> AuthData -> Request
- type AuthMechanism = ByteString
- type AuthData = ByteString
- addOpaque :: Opaque -> Request -> Request
- addCAS :: CAS -> Request -> Request
- data Response = Res {
- rsMagic :: RsMagic
- rsOp :: OpCode
- rsDataType :: DataType
- rsStatus :: ResponseStatus
- rsOpaque :: Opaque
- rsCas :: CAS
- rsExtras :: ByteString
- rsKey :: ByteString
- rsBody :: ByteString
- getResponse :: Handle -> IO Response
- data StarlingReadError = StarlingReadError
- class Serialize a where
- class Deserialize a where
- deserialize :: Get a
- type Opaque = Word32
- data OpCode
- data DataType = RawData
- data CAS
- nullCAS :: CAS
- data ResponseStatus
Documentation
type Key = ByteStringSource
type Value = ByteStringSource
stat :: Maybe Key -> RequestSource
Fetch statistics about the cahce. Returns a sequence of responses.
listAuthMechanisms :: RequestSource
List SASL authenitication mechanisms, space delimeted
startAuth :: AuthMechanism -> AuthData -> RequestSource
Begin SASL authentication. May return the further auth required error if further steps are needed.
stepAuth :: AuthMechanism -> AuthData -> RequestSource
Continue SASL authentication. May return the further aut required error if further steps are needed.
type AuthMechanism = ByteStringSource
type AuthData = ByteStringSource
addOpaque :: Opaque -> Request -> RequestSource
Add an opaque marker to a request. This is returned unchanged in the corresponding response.
addCAS :: CAS -> Request -> RequestSource
Add a version tag to a request. When added to a set/replace request, the request will fail if the data has been modified since the CAS was retrieved for the item.
Constructors
| Res | |
Fields
| |
getResponse :: Handle -> IO ResponseSource
Pulls a reponse to an operation
off of a handle.
May throw a StarlingReadError
data StarlingReadError Source
Constructors
| StarlingReadError |
class Deserialize a whereSource
Methods
deserialize :: Get aSource
Instances
| Deserialize OpCode | |
| Deserialize ResponseStatus | |
| Deserialize DataType | |
| Deserialize RsMagic | |
| Deserialize ResponseHeader | |
| Deserialize Response | |
| Deserialize CAS |
Constructors
| RawData |