YUKI Hiroshi
null+****@clear*****
Tue Jan 22 16:00:58 JST 2013
YUKI Hiroshi 2013-01-22 16:00:58 +0900 (Tue, 22 Jan 2013) New Revision: b4066d8fb4e12ed875954a36a6c527317ae902fa https://github.com/groonga/express-kotoumi/commit/b4066d8fb4e12ed875954a36a6c527317ae902fa Log: readme: add usage of express-kotoumi Modified files: README.md Modified: README.md (+66 -0) =================================================================== --- README.md 2013-01-21 19:11:06 +0900 (6b61299) +++ README.md 2013-01-22 16:00:58 +0900 (8adaeec) @@ -3,3 +3,69 @@ express-kotoumi provides a framework for building scalable realtime web API services for Express. +# usage + +## server + +If both kotoumi (fluentd) is running on the same server, you can use +express-kotoumi easily. + + var express = require('express'), + kotoumi = require('express-kotoumi'); + + var application = express(); + var server = require('http').createServer(application); + server.listen(80); // the port to communicate with clients + + application.kotoumi({ + prefix: '/kotoumi', + tag: 'groonga', + server: server, // this is required to initialize Socket.IO API! + extraCommands: [ // optional + // extra command will be sent to kotoumi via the Socket.IO API, as is. + 'groonga.reindex' + ] + }); + +Otherwise, you have to specify pairs of host and port to send messages +to the kotoumi and to receive messages from the kotoumi. + + application.kotoumi({ + prefix: '/kotoumi', + tag: 'groonga', + server: server, + extraCommands: [ + 'groonga.reindex' + ], + + // host and port to send messages to kotoumi + hostName: 'backend.kotoumi.example.org', + port: 24224, + + // host and port to receive messages from kotoumi + receiveHostName: 'express.kotoumi.example.org', + receivePort: 10030 + }); + + +## client (REST) + +Frontend applications can call REST APIs to access resources stored in +the kotoumi. For example: + + GET /kotoumi/tables/entries?query=foobar HTTP/1.1 + +It works as a search request, and a JSON string will be returned as the result. + +## client (Socket.IO) + +Frontend applications can call raw APIs via Socket.IO. For example: + + var socket = io.connect('http://example.com:80'); + socket.on('search.result', function(data) { + var records = data.body.records; + ... + }); + socket.emit('search', { query: 'foobar' }); + +In Socket.IO APIs, you'll send requests and receive results separately. -------------- next part -------------- HTML����������������������������...다운로드
