Database.Memcache.Types

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

SASL Authentication

data Authentication

SASL Authentication information for a server.

Constructors

Auth

Fields

• username :: !Username
• password :: !Password

NoAuth

Instances

Eq Authentication

Defined in Database.Memcache.Types

Methods

(==) :: Authentication -> Authentication -> Bool

(/=) :: Authentication -> Authentication -> Bool

Show Authentication

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> Authentication -> ShowS

show :: Authentication -> String

showList :: [Authentication] -> ShowS

type Username = ByteString

Username for authentication.

type Password = ByteString

Password for authentication.

Fields & Values

data Q

Constructors

Loud

Quiet

Instances

Eq Q

Defined in Database.Memcache.Types

Methods

(==) :: Q -> Q -> Bool

(/=) :: Q -> Q -> Bool

Show Q

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> Q -> ShowS

show :: Q -> String

showList :: [Q] -> ShowS

data K

Constructors

NoKey

IncludeKey

Instances

Eq K

Defined in Database.Memcache.Types

Methods

(==) :: K -> K -> Bool

(/=) :: K -> K -> Bool

Show K

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> K -> ShowS

show :: K -> String

showList :: [K] -> ShowS

type Key = ByteString

type Value = ByteString

type Extras = ByteString

type Initial = Word64

type Delta = Word64

type Expiration = Word32

type Flags = Word32

type Version = Word64

data Status

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

Defined in Database.Memcache.Types

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Show Status

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

Header

data Header

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

Instances

Eq Header

Defined in Database.Memcache.Types

Methods

(==) :: Header -> Header -> Bool

(/=) :: Header -> Header -> Bool

Show Header

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

mEMCACHE_HEADER_SIZE :: Int

data PktType

Constructors

PktRequest

PktResponse

Instances

Eq PktType

Defined in Database.Memcache.Types

Methods

(==) :: PktType -> PktType -> Bool

(/=) :: PktType -> PktType -> Bool

Show PktType

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> PktType -> ShowS

show :: PktType -> String

showList :: [PktType] -> ShowS

Requests

data Request

Constructors

Req

Fields

• reqOp :: OpRequest
• reqOpaque :: Word32
• reqCas :: Version

Instances

Eq Request

Defined in Database.Memcache.Types

Methods

(==) :: Request -> Request -> Bool

(/=) :: Request -> Request -> Bool

Show Request

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> Request -> ShowS

show :: Request -> String

showList :: [Request] -> ShowS

data OpRequest

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

ReqRaw Word8 (Maybe Key) (Maybe Value) SERaw

Warning: This is dangerous; no future compatability guaranteed

Raw request is custom requests, dangerous as no corresponding raw response...

Instances

Eq OpRequest

Defined in Database.Memcache.Types

Methods

(==) :: OpRequest -> OpRequest -> Bool

(/=) :: OpRequest -> OpRequest -> Bool

Show OpRequest

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> OpRequest -> ShowS

show :: OpRequest -> String

showList :: [OpRequest] -> ShowS

data SESet

Constructors

SESet Flags Expiration

Instances

Eq SESet

Defined in Database.Memcache.Types

Methods

(==) :: SESet -> SESet -> Bool

(/=) :: SESet -> SESet -> Bool

Show SESet

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> SESet -> ShowS

show :: SESet -> String

showList :: [SESet] -> ShowS

data SEIncr

Constructors

SEIncr Initial Delta Expiration

Instances

Eq SEIncr

Defined in Database.Memcache.Types

Methods

(==) :: SEIncr -> SEIncr -> Bool

(/=) :: SEIncr -> SEIncr -> Bool

Show SEIncr

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> SEIncr -> ShowS

show :: SEIncr -> String

showList :: [SEIncr] -> ShowS

data SETouch

Constructors

SETouch Expiration

Instances

Eq SETouch

Defined in Database.Memcache.Types

Methods

(==) :: SETouch -> SETouch -> Bool

(/=) :: SETouch -> SETouch -> Bool

Show SETouch

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> SETouch -> ShowS

show :: SETouch -> String

showList :: [SETouch] -> ShowS

data SERaw

Constructors

SERaw Builder Int

Instances

Eq SERaw

Defined in Database.Memcache.Types

Methods

(==) :: SERaw -> SERaw -> Bool

(/=) :: SERaw -> SERaw -> Bool

Show SERaw

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> SERaw -> ShowS

show :: SERaw -> String

showList :: [SERaw] -> ShowS

emptyReq :: Request

Noop request.

Responses

data Response

Memcached response packet.

Constructors

Res

Fields

• resOp :: OpResponse
• resStatus :: Status
• resOpaque :: Word32
• resCas :: Version

Instances

Eq Response

Defined in Database.Memcache.Types

Methods

(==) :: Response -> Response -> Bool

(/=) :: Response -> Response -> Bool

Show Response

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

data OpResponse

Constructors

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

Instances

Eq OpResponse

Defined in Database.Memcache.Types

Methods

(==) :: OpResponse -> OpResponse -> Bool

(/=) :: OpResponse -> OpResponse -> Bool

Show OpResponse

Defined in Database.Memcache.Types

Methods

showsPrec :: Int -> OpResponse -> ShowS

show :: OpResponse -> String

showList :: [OpResponse] -> ShowS

emptyRes :: Response

Noop response.