Copyright	(c) David Terei, 2016
License	BSD
Maintainer	code@davidterei.com
Stability	stable
Portability	GHC
Safe Haskell	Safe
Language	Haskell2010

Database.Memcache.Types

Contents

SASL Authentication
Fields & Values
Header
Requests
Responses

Description

Stores the various types needed by Memcached. Mostly concerned with the representation of the protocol.

Synopsis

SASL Authentication

data Authentication Source

SASL Authentication information for a server.

Constructors

Auth
Fields username :: !Username password :: !Password
NoAuth

Instances

Eq Authentication Source
Show Authentication Source

type Username = ByteString Source

Username for authentication.

type Password = ByteString Source

Password for authentication.

Fields & Values

data Q Source

Constructors

Loud
Quiet

Instances

Eq Q Source
Show Q Source

data K Source

Constructors

NoKey
IncludeKey

Instances

Eq K Source
Show K Source

type Key = ByteString Source

type Value = ByteString Source

type Extras = ByteString Source

type Initial = Word64 Source

type Delta = Word64 Source

type Expiration = Word32 Source

type Flags = Word32 Source

type Version = Word64 Source

data Status Source

The status (success or error) of a Memcached operation returned in a Response.

Constructors

NoError	Operation successful.
ErrKeyNotFound	Key not found.
ErrKeyExists	Key exists when not expected.
ErrValueTooLarge	Value too large to store at server.
ErrInvalidArgs	Invalid arguments for operation.
ErrItemNotStored	Key-Value pair not stored at server (internal error).
ErrValueNonNumeric	Value not numeric when increment or decrement requested.
ErrUnknownCommand	Server doesn't know requested command.
ErrOutOfMemory	Server out of memory.
SaslAuthFail	SASL authentication failed.
SaslAuthContinue	SASL authentication requires more steps.

Instances

Eq Status Source
Show Status Source

Header

data Header Source

Memcached packet header (for both Request and Response).

Constructors

Header
Fields op :: Word8 keyLen :: Word16 extraLen :: Word8 status :: Status bodyLen :: Word32 opaque :: Word32 cas :: Version

mEMCACHE_HEADER_SIZE :: Int Source

data PktType Source

Constructors

PktRequest
PktResponse

Instances

Eq PktType Source
Show PktType Source

Requests

data Request Source

Constructors

Req
Fields reqOp :: OpRequest reqOpaque :: Word32 reqCas :: Version

Instances

Eq Request Source
Show Request Source

data OpRequest Source

Constructors

ReqGet Q K Key
ReqSet Q Key Value SESet
ReqAdd Q Key Value SESet
ReqReplace Q Key Value SESet
ReqDelete Q Key
ReqIncrement Q Key SEIncr
ReqDecrement Q Key SEIncr
ReqAppend Q Key Value
ReqPrepend Q Key Value
ReqTouch Key SETouch
ReqGAT Q K Key SETouch
ReqFlush Q (Maybe SETouch)
ReqNoop
ReqVersion
ReqStat (Maybe Key)
ReqQuit Q
ReqSASLList
ReqSASLStart Key Value
ReqSASLStep Key Value

Instances

Eq OpRequest Source
Show OpRequest Source

data SESet Source

Constructors

SESet Flags Expiration

Instances

Eq SESet Source
Show SESet Source

data SEIncr Source

Constructors

SEIncr Initial Delta Expiration

Instances

Eq SEIncr Source
Show SEIncr Source

data SETouch Source

Constructors

SETouch Expiration

Instances

Eq SETouch Source
Show SETouch Source

emptyReq :: Request Source

Noop request.

Responses

data Response Source

Memcached response packet.

Constructors

Res
Fields resOp :: OpResponse resStatus :: Status resOpaque :: Word32 resCas :: Version

Instances

Eq Response Source
Show Response Source

data OpResponse Source

Instances

Eq OpResponse Source
Show OpResponse Source

emptyRes :: Response Source

Noop response.

ResGet Q Value Flags
ResGetK Q Key Value Flags
ResSet Q
ResAdd Q
ResReplace Q
ResDelete Q
ResIncrement Q Word64
ResDecrement Q Word64
ResAppend Q
ResPrepend Q
ResTouch
ResGAT Q Value Flags
ResGATK Q Key Value Flags
ResFlush Q
ResNoop
ResVersion Value
ResStat Key Value
ResQuit Q
ResSASLList Value
ResSASLStart
ResSASLStep