+ Dfjc\Rt^RIHt^RIHtHtHt^RIHt^RI H t ^RI H t ^RI HtHtRt!RR ]4t!R R ]4t!R R ]4t!RR4t!RR]] 4t.ROtR#)ap Memcache client protocol. Memcached is a caching server, storing data in the form of pairs key/value, and memcache is the protocol to talk with it. To connect to a server, create a factory for L{MemCacheProtocol}:: from twisted.internet import reactor, protocol from twisted.protocols.memcache import MemCacheProtocol, DEFAULT_PORT d = protocol.ClientCreator(reactor, MemCacheProtocol ).connectTCP("localhost", DEFAULT_PORT) def doSomething(proto): # Here you call the memcache operations return proto.set("mykey", "a lot of data") d.addCallback(doSomething) reactor.run() All the operations of the memcache protocol are present, but L{MemCacheProtocol.set} and L{MemCacheProtocol.get} are the more important. See U{http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt} for more information about the protocol. )deque)Deferred TimeoutErrorfail) LineReceiver) TimeoutMixin)log) nativeString networkStringi+c]tRt^(tRtRtR#) NoSuchCommandz9 Exception raised when a non existent command is called. N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r ?@ %%'rc bRVnVPV4\P!W4R#)z) Cause any outstanding commands to fail. TN) _disconnectedrCrconnectionLost)r#rAs&&rrMMemCacheProtocol.connectionLosts(" V$##D1rc VP'gVPVP4\P!W4R#)z1 Override sendLine to add a timeout to response. N)r8 setTimeoutr<rsendLine)r#lines&&rrQMemCacheProtocol.sendLines-}}} OOD22 3d)rc VP4VPPV4V;P\ V4, unVPVP ^,8dRP VP4pVRVP pWP ^,RpTpRVnRVnRVnVP^,pVP'd<VPVP,wrgWgV3VPVP&MWEn VPV4R#R#)z Collect data for a get. rN) resetTimeoutr:appendr;lenr9joinr8multiplevalues currentKeyr+ setLineMode)r#databufremvalrBflagscass&& rrawDataReceived MemCacheProtocol.rawDataReceiveds  t$ c$i'   !2!2Q!6 688DOO,D***+C((1,./CC $D "DO!%D --"C||| ZZ7 .3#-> 3>>*   S ! 7rc XVPP4PR4R#)z/ Manage a success response to a set operation. TNr8r@r,rHs&r cmd_STOREDMemCacheProtocol.cmd_STORED ''-rc XVPP4PR4R#)zr Manage a specific 'not stored' response to a set operation: this is not an error, but some condition wasn't met. FNrfrHs&rcmd_NOT_STOREDMemCacheProtocol.cmd_NOT_STOREDs ''.rc VPP4pVPR8XdVP'dHVPP 4UUu/uFwr#W#R,bK pppVP V4R#VP VPVP34R#VPR8XddVP'dVP VP4R#VP VPVPVP34R#VPR8XdVP VP4R#\RP\VP444huuppi)z2 This the end token to a get or a stat operation. get:NNgetsstatsz%Unexpected END response to {} commandN) r8r@rrYrZr!r,rar+rb RuntimeErrorformatr )r#rBkeyr`rZs& rcmd_ENDMemCacheProtocol.cmd_ENDsmm##% ;;& |||8; 8H8H8JK8JHC#3x-8JK F# SYY 23 [[G #||| CJJ' SYY;< [[H $ KK #7>> - LsE=c XVPP4PR4R#)z- Manage error response for incr/decr/delete. FNrfrHs&r cmd_NOT_FOUNDMemCacheProtocol.cmd_NOT_FOUND ''.rc VP^,pVPR8XdVP4wr4pRpMVP4wr4rV\V4Vn.Vn^VnVP'd=W2P9d \R4hW2n \V4V.VPV&M2VPV8wd \R4h\V4Vn WbnVP4R#)z* Prepare the reading a value after a get. rnrzUnexpected commands answer.N)r8rsplitintr9r:r;rYkeysrrr[rZrtrarb setRawMode)r#rRrBrtralengthrbs&& r cmd_VALUEMemCacheProtocol.cmd_VALUEsmmA ;;& !% CC&*jjl #CK <<<((""#@AA N"5z3/CJJsOww#~"#@AAE CIG rc pVP^,pVPR^4wr4WBPV&R#)z Reception of one stat line.  N)r8r|rZ)r#rRrBrtr`s&& rcmd_STATMemCacheProtocol.cmd_STAT s/mmA::dA& 3rc XVPP4PV4R#)z Read version token. Nrf)r# versionDatas&&r cmd_VERSIONMemCacheProtocol.cmd_VERSIONs '' 4rc \P!R4VPP4pVP \ 44R#)z' A non-existent command has been sent. zNon-existent command sent.N)rerrr8r@rr )r#rBs& r cmd_ERRORMemCacheProtocol.cmd_ERRORs1 ,-mm##% !rc \V4p\P!RV,4VPP 4pVP \ V44R#)z An invalid input as been sent. zInvalid input: N)reprrrr8r@rrr#errTextrBs&& rcmd_CLIENT_ERROR!MemCacheProtocol.cmd_CLIENT_ERRORsBw- !G+,mm##% W%&rc \V4p\P!RV,4VPP 4pVP \ V44R#)z$ An error has happened server-side. zServer error: N)rrrr8r@rrrs&& rcmd_SERVER_ERROR!MemCacheProtocol.cmd_SERVER_ERROR(sBw-  7*+mm##% W%&rc XVPP4PR4R#)z. A delete command has completed successfully. TNrfrHs&r cmd_DELETEDMemCacheProtocol.cmd_DELETED1rirc XVPP4PR4R#)z& The last command has been completed. TNrfrHs&rcmd_OKMemCacheProtocol.cmd_OK7rirc XVPP4PR4R#)z% A C{checkAndSet} update has failed. FNrfrHs&r cmd_EXISTSMemCacheProtocol.cmd_EXISTS=rzrc 8VP4VPR^4^,p\VR\V4,R4pVe:VPR^4R,pV'dV!V^,4MyV!4MqVP RR4p\VR\V4,R4pVe V!4M6VP P 4p\V4pVPV4VP 'gVPR4R#R#)z( Receive line commands from the server. rcmd_N:NN_) rUr|getattrr replacer8r@r}r,rP)r#rRtokenrBargsr`s&& r lineReceivedMemCacheProtocol.lineReceivedCs  4#A&dF\%%88$? ?::dA&r*DDG <<d+D$d); ;TBCmm++-$i C }}} OOD !rc &VPRW4#)an Increment the value of C{key} by given value (default to 1). C{key} must be consistent with an int. Return the new value. @param key: the key to modify. @type key: L{bytes} @param val: the value to increment. @type val: L{int} @return: a deferred with will be called back with the new value associated with the key (after the increment). @rtype: L{Deferred} sincr _incrdecrr#rtr`s&&&r incrementMemCacheProtocol.increment`s~~gs00rc &VPRW4#)a Decrement the value of C{key} by given value (default to 1). C{key} must be consistent with an int. Return the new value, coerced to 0 if negative. @param key: the key to modify. @type key: L{bytes} @param val: the value to decrement. @type val: L{int} @return: a deferred with will be called back with the new value associated with the key (after the decrement). @rtype: L{Deferred} sdecrrrs&&&r decrementMemCacheProtocol.decrementqs ~~gs00rc VP'd\\R44#\V\4'g"\\ R\ V4 R244#\V4VP8d\\ R44#RPWR\V43,.4pVPV4\WR7pVPPV4VP#)z! Internal wrapper for incr/decr. not connectedInvalid type for key: , expecting bytes Key too longrs%drt)rLrrr isinstancebytesrtyperWMAX_KEY_LENGTHrXr}rQrr8rVr )r#rBrtr`fullcmdcmdObjs&&&& rrMemCacheProtocol._incrdecrs     _56 6#u%%4T#YK?PQR  s8d)) ) N34 4))SuC{':;< g& V$rc *VPRWW4R4#)a- Replace the given C{key}. It must already exist in the server. @param key: the key to replace. @type key: L{bytes} @param val: the new value associated with the key. @type val: L{bytes} @param flags: the flags to store with the key. @type flags: L{int} @param expireTime: if different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: a deferred that will fire with C{True} if the operation has succeeded, and C{False} with the key didn't previously exist. @rtype: L{Deferred} sreplacer_setr#rtr`ra expireTimes&&&&&rrMemCacheProtocol.replaces*yySu#FFrc *VPRWW4R4#)a Add the given C{key}. It must not exist in the server. @param key: the key to add. @type key: L{bytes} @param val: the value associated with the key. @type val: L{bytes} @param flags: the flags to store with the key. @type flags: L{int} @param expireTime: if different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: a deferred that will fire with C{True} if the operation has succeeded, and C{False} with the key already exists. @rtype: L{Deferred} saddrrrs&&&&&raddMemCacheProtocol.add*yy5cBBrc *VPRWW4R4#)a Set the given C{key}. @param key: the key to set. @type key: L{bytes} @param val: the value associated with the key. @type val: L{bytes} @param flags: the flags to store with the key. @type flags: L{int} @param expireTime: if different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: a deferred that will fire with C{True} if the operation has succeeded. @rtype: L{Deferred} ssetrrrs&&&&&rsetMemCacheProtocol.setrrc *VPRWWEV4#)a Change the content of C{key} only if the C{cas} value matches the current one associated with the key. Use this to store a value which hasn't been modified since last time you fetched it. @param key: The key to set. @type key: L{bytes} @param val: The value associated with the key. @type val: L{bytes} @param cas: Unique 64-bit value returned by previous call of C{get}. @type cas: L{bytes} @param flags: The flags to store with the key. @type flags: L{int} @param expireTime: If different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: A deferred that will fire with C{True} if the operation has succeeded, C{False} otherwise. @rtype: L{Deferred} scasr)r#rtr`rbrars&&&&&&r checkAndSetMemCacheProtocol.checkAndSets4yy5cBBrc  VP'd\\R44#\V\4'g"\\ R\ V4 R244#\V4VP8d\\ R44#\V\4'g"\\ R\ V4 R244#V'd RV,p\V4pRPW\RWEV3,4.4V,pVPV4VPV4\WWGR7p VPPV 4V P#) z& Internal wrapper for setting values. rrrrzInvalid type for value: rz%d %d %d)rtrar)rLrrrrrrrrWrrXr rQrr8rVr ) r#rBrtr`rarrbrrrs &&&&&&& rrMemCacheProtocol._sets3     _56 6#u%%4T#YK?PQR  s8d)) ) N34 4#u%%6tCykARST  *CS II=u&6Q)QRS    g cUB V$rc ,VPRW^^R4#)aL Append given data to the value of an existing key. @param key: The key to modify. @type key: L{bytes} @param val: The value to append to the current value associated with the key. @type val: L{bytes} @return: A deferred that will fire with C{True} if the operation has succeeded, C{False} otherwise. @rtype: L{Deferred} sappendrrrs&&&rrVMemCacheProtocol.appends yyCaC88rc ,VPRW^^R4#)aN Prepend given data to the value of an existing key. @param key: The key to modify. @type key: L{bytes} @param val: The value to prepend to the current value associated with the key. @type val: L{bytes} @return: A deferred that will fire with C{True} if the operation has succeeded, C{False} otherwise. @rtype: L{Deferred} sprependrrrs&&&rprependMemCacheProtocol.prepend's yySq!S99rc *VPV.VR4#)a6 Get the given C{key}. It doesn't support multiple keys. If C{withIdentifier} is set to C{True}, the command issued is a C{gets}, that will return the current identifier associated with the value. This identifier has to be used when issuing C{checkAndSet} update later, using the corresponding method. @param key: The key to retrieve. @type key: L{bytes} @param withIdentifier: If set to C{True}, retrieve the current identifier along with the value and the flags. @type withIdentifier: L{bool} @return: A deferred that will fire with the tuple (flags, value) if C{withIdentifier} is C{False}, or (flags, cas identifier, value) if C{True}. If the server indicates there is no value associated with C{key}, the returned value will be L{None} and the returned flags will be C{0}. @rtype: L{Deferred} F_get)r#rtwithIdentifiers&&&rgetMemCacheProtocol.get9s,yy#66rc &VPWR4#)at Get the given list of C{keys}. If C{withIdentifier} is set to C{True}, the command issued is a C{gets}, that will return the identifiers associated with each values. This identifier has to be used when issuing C{checkAndSet} update later, using the corresponding method. @param keys: The keys to retrieve. @type keys: L{list} of L{bytes} @param withIdentifier: If set to C{True}, retrieve the identifiers along with the values and the flags. @type withIdentifier: L{bool} @return: A deferred that will fire with a dictionary with the elements of C{keys} as keys and the tuples (flags, value) as values if C{withIdentifier} is C{False}, or (flags, cas identifier, value) if C{True}. If the server indicates there is no value associated with C{key}, the returned values will be L{None} and the returned flags will be C{0}. @rtype: L{Deferred} @since: 9.0 Tr)r#r~rs&&&r getMultipleMemCacheProtocol.getMultipleQs0yyt44rc  \V4pVP'd\\R44#VFlp\ V\ 4'g$\\ R\V4 R244u#\V4VP8gKX\\ R44u# V'dRpMRpRPV.V,4pVPV4V'd!VUu/uFqDRbK pp\WQVR R 7pM\WQ^,R ^RR R 7pVPPV4VP#uupi)z. Helper method for C{get} and C{getMultiple}. rrrrrprnrrNT)r~rZrYF)rtr+rarbrY)rN)listrLrrrrrrrrWrrXrQrr8rVr ) r#r~rrYrtrBrrZrs &&&& rrMemCacheProtocol._getksDz     _56 6Cc5))"8c CT UV3x$---K788  CC))SEDL) g 59:Tc>)TF:SFTJFaA3F V$;s' ENc V'd RV,pMRpVP'd\\R44#VPV4\ R/R7pVP P V4VP#)a Get some stats from the server. It will be available as a dict. @param arg: An optional additional string which will be sent along with the I{stats} command. The interpretation of this value by the server is left undefined by the memcache protocol specification. @type arg: L{None} or L{bytes} @return: a deferred that will fire with a L{dict} of the available statistics. @rtype: L{Deferred} sstats rqr)rZrLrrrrQrr8rVr )r#argrBrs&& rstatsMemCacheProtocol.statssg c/CC     _56 6 c"- V$rc VP'd\\R44#VPR4\ R4pVP P V4VP#)z Get the version of the server. @return: a deferred that will fire with the string value of the version. @rtype: L{Deferred} rsversionrr#rs& rversionMemCacheProtocol.versionsT     _56 6 j!$ V$rc TVP'd\\R44#\V\4'g"\\ R\ V4 R244#VPRV,4\RVR7pVPPV4VP#)z Delete an existing C{key}. @param key: the key to delete. @type key: L{bytes} @return: a deferred that will be called back with C{True} if the key was successfully deleted, or C{False} if not. @rtype: L{Deferred} rrrsdelete sdeleter) rLrrrrrrrrQrr8rVr )r#rtrs&& rdeleteMemCacheProtocol.deletes     _56 6#u%%4T#YK?PQR  j3&', V$rc VP'd\\R44#VPR4\ R4pVP P V4VP#)z Flush all cached values. @return: a deferred that will be called back with C{True} when the operation has succeeded. @rtype: L{Deferred} rs flush_allrrs& rflushAllMemCacheProtocol.flushAllsT     _56 6 l#& V$r)r;r8rLr:r9r<r=)<)r)rr)F)N).rrrrrrrLr'rCrIrMrQrcrgrkrurxrrrrrrrrrrrrrrrrrrrVrrrrrrrrrr2r3s@rr6r6cs2NM 8(2*".. /2/ 25 "''. . / ":1"1$ $G.C.C.C8 >9$:$7054 < 2   ,   rr6N)r6 DEFAULT_PORTr rr)r collectionsrtwisted.internet.deferrrrtwisted.protocols.basicrtwisted.protocols.policiesrtwisted.pythonrtwisted.python.compatr r r Exceptionr rrrr6__all__r rrrsm 0??03= I ) ) &&&&Rq  |\q  h r