Skip to content

Latest commit

 

History

History
102 lines (76 loc) · 3.31 KB

README.md

File metadata and controls

102 lines (76 loc) · 3.31 KB
Raw

#Memcached Client

Memcached Client is a client implementation in Dart language of the famous distributed memory object caching system, [Memcached] (http://memcached.org/).

Memcached Client is distributed under the Apache 2.0 License.

##Install from Dart Pub Repository

Add this to your pubspec.yaml (or create it):

dependencies:
  memcached_client:

Then run the Pub Package Manager (comes with the Dart SDK):

pub install

##Install from Github for Bleeding Edge Stuff

To install stuff that is still in development, add this to your pubspec.yam:

dependencies:
  memcached_client:
    git: git://github.com/rikulo/memcached-client.git

For more information, please refer to [Pub: Dependencies] (http://pub.dartlang.org/doc/pubspec.html#dependencies).

##Usage

Using Memcached Client is straightforward. Connect to the server and use the client's APIs to access the database.

import "dart:convert" show UTF8;
import "dart:async";
import "package:memcached_client/memcached_client.dart";

void main() {
  // Connect to server per the provided SocketAddress
  // Here assume your Memcached Server is installed on localhost
  MemcachedClient.connect([new SocketAddress("127.0.0.1", 11211)])
  // When client is ready, access the database
  .then((client) => access(client))
  // Catch all possible errors/exceptions
  .catchError((err) => print('Exception: $err'));
}

// The unique document id of the document
final String DOC_ID = "beer_Wrath";

// The Json encoded document
final String VALUE =
  '{"name":"Wrath","abv":9.0,'
  '"type":"beer","brewery_id":"110f1a10e7",'
  '"updated":"2010-07-22 20:00:20",'
  '"description":"WRATH Belgian-style ",'
  '"style":"Other Belgian-Style Ales",'
  '"category":"Belgian and French Ale"}';

Future access(MemcachedClient client) {
  // Do a set
  return client.set(DOC_ID, encodeUtf8(VALUE))
  // Check if set succeeded and show message
  .then((ok) => print(ok ? "Set Succeeded" : "Set failed"))
  // Then get the value back by document id
  .then((_) => client.get(DOC_ID))
  // Check if get data equals to set one
  .then((val) => UTF8.decode(val.data) == VALUE)
  // Show message
  .then((ok) => print(ok ? "Get Succeeded" : "Get failed"))
  // Close the client
  .then((_) => client.close());
}

##Notes to Contributors

###Test and Debug

You are welcome to submit [bugs and feature requests] (https://github.com/rikulo/memcached-client/issues). Or even better if you can fix or implement them!

###Fork Memcached Client

If you'd like to contribute back to the core, you can [fork this repository] (https://help.github.com/articles/fork-a-repo) and send us a pull request, when it is ready.

Please be aware that one of Memcached Client's design goals is to keep the sphere of API as neat and consistency as possible. Strong enhancement always demands greater consensus.

If you are new to Git or GitHub, please read this guide first.