How couchbase/spymemcached works
Spymemcached is a Java client library for issuing asynchronous and synchronous cache operations against Memcached-compatible servers. Applications call the client API; it constructs operations, routes them through a managed connection to server nodes, and exposes completion/results through futures and callbacks. The code also supports serialization, authentication, TAP streaming, and metrics. The README focuses on building and testing and does not document product behavior, so the map relies on the source index and sampled excerpts; unsampled protocol and configuration links are omitted where not evidenced.
Main entry points: MemcachedConnection.java Connection Manager · MemcachedClient.java Memcached Client · ops Cache Operations · ResponseMessage.java TAP Messages
Components 21
Client API
- Memcached Client
src/main/java/net/spy/memcached/MemcachedClient.java - Client Interface
src/main/java/net/spy/memcached/MemcachedClientIF.java - Operation Factory
src/main/java/net/spy/memcached/OperationFactory.java - Cache Operations
src/main/java/net/spy/memcached/ops - Operation Futures
src/main/java/net/spy/memcached/internal/OperationFuture.java
Connection Runtime
- Connection Manager
src/main/java/net/spy/memcached/MemcachedConnection.java - Node Queue API
src/main/java/net/spy/memcached/MemcachedNode.java - TCP Node Runtime
src/main/java/net/spy/memcached/protocol/TCPMemcachedNodeImpl.java - Node Locators
src/main/java/net/spy/memcached/NodeLocator.java
Protocols and TAP
- Protocol Operations
src/main/java/net/spy/memcached/protocol/BaseOperationImpl.java - ASCII Protocol
src/main/java/net/spy/memcached/protocol/ascii/AsciiOperationFactory.java - Binary Protocol
src/main/java/net/spy/memcached/protocol/binary/BinaryOperationFactory.java - TAP Client
src/main/java/net/spy/memcached/TapClient.java - TAP Messages
src/main/java/net/spy/memcached/tapmessage/ResponseMessage.java
Data and Support
- Transcoders
src/main/java/net/spy/memcached/transcoders/Transcoder.java - Cached Data
src/main/java/net/spy/memcached/CachedData.java - SASL Authentication
src/main/java/net/spy/memcached/auth/AuthThread.java - Auth Descriptor
src/main/java/net/spy/memcached/auth/AuthDescriptor.java - Metrics Collector
src/main/java/net/spy/memcached/metrics/DefaultMetricCollector.java
Other components
- Application
- Memcached Servers
Connections 22
- Application → Client Interface: calls
src/main/java/net/spy/memcached/MemcachedClientIF.java - Memcached Client → Operation Factory: creates operations
src/main/java/net/spy/memcached/MemcachedClient.java - Memcached Client → Connection Manager: enqueues operations
src/main/java/net/spy/memcached/MemcachedClient.java - Memcached Client → Operation Futures: returns futures
src/main/java/net/spy/memcached/MemcachedClient.java - Memcached Client → Transcoders: decodes values
src/main/java/net/spy/memcached/MemcachedClient.java - Memcached Client → Cached Data: wraps response data
src/main/java/net/spy/memcached/MemcachedClient.java - Operation Factory → Cache Operations: creates
src/main/java/net/spy/memcached/OperationFactory.java - Connection Manager → Node Queue API: manages nodes
src/main/java/net/spy/memcached/MemcachedConnection.java - Connection Manager → Cache Operations: initializes and routes
src/main/java/net/spy/memcached/MemcachedConnection.java - TCP Node Runtime → Node Queue API: implements
src/main/java/net/spy/memcached/protocol/TCPMemcachedNodeImpl.java - Connection Manager → Node Locators: selects nodes
src/main/java/net/spy/memcached/MemcachedConnection.java - TCP Node Runtime → Memcached Servers: communicates
- Protocol Operations → Cache Operations: implements
src/main/java/net/spy/memcached/protocol/BaseOperationImpl.java - ASCII Protocol → Protocol Operations: specializes
- Binary Protocol → Protocol Operations: specializes
- TAP Client → Cache Operations: submits TAP operations
src/main/java/net/spy/memcached/TapClient.java - TAP Client → TAP Messages: uses messages
src/main/java/net/spy/memcached/TapClient.java - TAP Messages → Cached Data: represents data
src/main/java/net/spy/memcached/tapmessage/ResponseMessage.java - TAP Messages → Transcoders: uses serialization
src/main/java/net/spy/memcached/tapmessage/ResponseMessage.java - SASL Authentication → Auth Descriptor: uses credentials
src/main/java/net/spy/memcached/auth/AuthThread.java - SASL Authentication → Connection Manager: coordinates authentication
src/main/java/net/spy/memcached/auth/AuthThread.java - Connection Manager → Metrics Collector: records metrics