forked from msgpack/website
/
index.html
466 lines (419 loc) · 20.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta http-equiv="content-script-type" content="text/javascript" />
<meta http-equiv="content-style-type" content="text/css" />
<title>The MessagePack Project</title>
<meta name="description" content="MessagePack Web Site" />
<meta name="keywords" content="MessagePack, msgpack, serialize, deserialize, JSON, Protocol Buffers, BERT, Thrift" />
<script src="index/prettify.js" type="text/javascript"></script>
<link href="index/prettify.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" type="text/css" href="index/yui/cssreset/reset-min.css" />
<link rel="stylesheet" type="text/css" href="index/yui/cssfonts/fonts-min.css" />
<link rel="stylesheet" type="text/css" href="index/yui/cssbase/base-min.css" />
<link rel="stylesheet" type="text/css" href="index/msgpack.css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17125377-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body onload="prettyPrint()">
<div id="header" class="container">
<h1>MessagePack</h1>
<p id="summary">Extremely efficient object serialization library for cross-language communication.<br />It's like JSON, but very fast and small.</p>
</div>
<div id="navi" class="container">
<ul id="navi_links">
<li>
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart">
<span class="navi_title">Getting Started</span>
<span class="navi_desc">Install and Try it Now</span>
</a>
</li>
<li style="width:140px;">
<a href="http://wiki.msgpack.org/display/MSGPACK/Home">
<span class="navi_title">Wiki</span>
<span class="navi_desc">Learn more</span>
</a>
</li>
<li style="width:180px;">
<a href="http://jira.msgpack.org/browse/MSGPACK">
<span class="navi_title">Issues</span>
<span class="navi_desc">Issues and progress</span>
</a>
</li>
<li style="width:180px;">
<a href="http://github.org/msgpack">
<span class="navi_title">Source</span>
<span class="navi_desc">Repository at Github</span>
</a>
</li>
<li style="width:180px;">
<!--http://twitter.com/search?q=%23msgpack-->
<a href="http://twitter.com/search/MessagePack%20OR%20msgpack">
<span class="navi_title">#msgpack</span>
<span class="navi_desc">Find on Twitter</span>
</a>
</li>
</ul>
<div id="social" style="overflow:hidden;">
<div style="width:50px;height:43px;overflow:hidden;">
<script type="text/javascript">/*tweetmeme_style = 'compact';*/</script>
<script type="text/javascript" src="http://tweetmeme.com/i/scripts/button.js"></script>
</div>
<!--<iframe src="http://www.facebook.com/plugins/like.php?href=http%3A%2F%2Fmsgapck.org%2F&layout=button_count&show_faces=false&width=450&action=like&colorscheme=light&height=21" scrolling="no" frameborder="0" style="border:none; overflow:hidden; width:450px; height:21px;" allowTransparency="true"></iframe>-->
<iframe src="http://www.facebook.com/plugins/likebox.php?id=119810658044417&width=110&connections=0&stream=false&header=false&height=40" scrolling="no" frameborder="0" allowTransparency="true" style="border:none; height:40px; width:190px; margin: -9px 0 0 -60px;"></iframe>
</div>
</div>
<h2 id="Abstruct">What's MessagePack?</h2>
<div id="welcome" class="container">
<div id="welcome_description">
<h3>Fast and Compact Serialization</h3>
<p>MessagePack is a binary-based efficient object serialization library. It enables to exchange structured objects between many languages like JSON. But unlike JSON, it is very fast and small.</p>
<p>Typical small integer (like flags or error code) is saved only in 1 byte, and typical short string only needs 1 byte except the length of the string itself. [1,2,3] (3 elements array) is serialized in 4 bytes using MessagePack as follows:</p>
<pre class="prettyprint">> require 'msgpack'
> msg = [1,2,3].to_msgpack #=> "\x93\x01\x02\x03"
> MessagePack.unpack(msg) #=> [1,2,3]</pre>
<h3>Scalable RPC</h3>
<p>MessagePack-RPC is cross-language RPC library for client, server and cluster applications. Because it releases you from complicated network programming completely and provides well-designed API, you can easily implement advanced network applications with MessagePack-RPC.</p>
<!--<p>It is built on top of event-driven I/O architecture, and supports synchronous, asynchronous and callback-style RPC with multiple servers. Connection pooling is also supported. C++ and Java implementations are fully multithreaded, so the servers implemented on top of MessagePack-RPC automatically becomes scalable enough to serve thousands of clients.</p>-->
<pre class="prettyprint">require 'msgpack/rpc'
class MyHandler
def add(x,y) return x+y end
end
svr = MessagePack::RPC::Server.new
svr.listen('0.0.0.0', 18800, MyHandler.new)
svr.run
</pre>
<pre class="prettyprint">require 'msgpack/rpc'
c = MessagePack::RPC::Client.new('127.0.0.1',18800)
result = c.call(:add, 1, 2) #=> 3</pre>
</div>
<div id="welcome_figure">
<h3>Serialization + Deserialization Speed Test</h3>
<img id="speedtest" src="index/speedtest.png" width="440" height="225" alt="MessagePack Serialization + Deserialization Speed Test" />
<p class="caption">In this test (<a href="http://msgpack.org/releases/benchmark/msgpack-protobuf-json-speed-test.tar.gz">source code</a>), it measured the elapsed time of serializing and deserializing 200,000 target objects.
The target object consists of the three integers and 512 bytes string.</p>
<h3>RPC Feature Comparision</h3>
<table id="compare" summary="RPC Feature Comparision">
<colgroup>
<col class="header" />
<col span="1" class="main" />
<col span="2" class="sub" />
</colgroup>
<thead>
<tr>
<th></th>
<th>MessagePack-RPC</th>
<th>Thrift</th>
<th>Avro</th>
</tr>
</thead>
<tbody>
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-AsynchronousRPC">Asynchronous RPC</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="OK" src="index/icon-ng.png" width="18" height="18" /></td>
</tr>
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-ParallelPipelining">Parallel Pipelining</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
</tr>
<!--
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-IDLSupport">IDL Support</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
</tr>
-->
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-DynamicTyping">Dynamic Typing</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
</tr>
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-ConnectionPooling">Connection pooling</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
</tr>
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-DelayedReturn">Delayed return</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
</tr>
<tr>
<th><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC#DesignofRPC-EventdrivenI%2FO">Event-driven I/O</a></th>
<td><img alt="OK" src="index/icon-ok.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
<td><img alt="NG" src="index/icon-ng.png" width="18" height="18" /></td>
</tr>
</tbody>
</table>
<p class="caption">
Information of these related projects are available from: <a href="http://www.json.org/">JSON</a>, <a href="http://code.google.com/p/protobuf/">Protocol Buffers</a>, <a href="http://incubator.apache.org/thrift/">Thrift</a>, <a href="http://avro.apache.org/">Avro</a>.
</p>
</div>
</div>
<div id="getstart" class="container">
<h2 id="GettingStarted">Getting Started</h2>
<div class="box3" style="height:14em;">
<h3>Ruby</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Ruby">Quick Start</a>
<span>Reference:</span>
<a href="http://msgpack.org/rpc/rdoc/current/MessagePack/RPC.html">RPC</a>
<a href="http://msgpack.org/rdoc/current/MessagePack.html">Serialization</a>
</p>
<pre>> gem install msgpack
> gem install msgpack-rpc</pre>
<!--<p>Ruby implementation supports <a href="http://redmine.msgpack.org/projects/msgpack/wiki/FormatDesign">zero-copy</a> facility.</p>-->
</div>
<div class="box3" style="height:14em;">
<h3>Python</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Python">Quick Start</a>
<!--
<span>Reference:</span>
<a href="">RPC</a>
<a href="">Serialization</a>
-->
</p>
<pre>> easy_install msgpack-python</pre>
<p>More details for the package is available at the <a href="http://pypi.python.org/pypi/msgpack-python/">PyPI page</a>.</p>
</div>
<div class="box3" style="height:14em;">
<h3>Perl</h3>
<p class="getstart_links">
<!--<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Perl">Quick Start</a>-->
<span style="margin-left:0;">Reference:</span>
<a href="http://search.cpan.org/~tokuhirom/AnyEvent-MPRPC/">RPC</a>
<a href="http://search.cpan.org/~tokuhirom/Data-MessagePack/">Serialization</a>
</p>
<pre>> cpan Data::MessagePack
> cpan AnyEvent::MPRPC</pre>
</div>
<div class="box3" style="height:16em;">
<h3>C/C++</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/pages/viewpage.action?pageId=1081387">Quick Start</a>
<!--
<span>Reference:</span>
<a href="">RPC</a>
<a href="">Serialization</a>
-->
</p>
<pre>port install msgpack (<a href="http://www.macports.org/">MacPorts</a>)
brew install msgpack (<a href="http://mxcl.github.com/homebrew/">Homebrew</a>)</pre>
<p>Download <a href="http://msgpack.org/releases/cpp/msgpack-0.5.6.tar.gz">msgpack-0.5.6.tar.gz</a> and build it.
RPC for C++ is at <a href="http://msgpack.org/releases/cpp/msgpack-rpc-0.3.1.tar.gz">msgpack-rpc-0.3.1.tar.gz</a>.
<!--C/C++ implementation supports <a href="http://redmine.msgpack.org/projects/msgpack/wiki/FormatDesign">zero-copy</a> facility.</p>-->
<!--
It supports <strong>zero-copy</strong> facility.</p>
-->
</div>
<div class="box3" style="height:16em;">
<h3>Java</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Java">Quick Start</a>
<span>Reference:</span>
<a href="http://msgpack.org/rpc/javadoc/current/">RPC</a>
<a href="http://msgpack.org/javadoc/current/">Serialization</a>
</p>
<p>Maven2 repository is located <a href="http://msgpack.org/maven2/">here</a>. See <a href="/javadoc/current/">javadoc</a> for actual APIs.<!-- <a href="http://redmine.msgpack.org/projects/msgpack/wiki/QuickStartIDL">IDL</a> may be greatly useful with Java.</p>-->
<p>Source code is available from <a href="http://github.com/msgpack/msgpack/tree/master/java/">here</a>, and <a href="http://github.com/msgpack/msgpack/blob/master/java/src/test/java/org/msgpack/TestMessagePackStaticMethods.java">test cases</a> will give you a sample usage.</p>
</div>
<div class="box3" style="height:16em;">
<h3>Haskell</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Haskell">Quick Start</a>
<!--
<span>Reference:</span>
<a href="">RPC</a>
<a href="">Serialization</a>
-->
</p>
<pre>> cabal install msgpack
> cabal install msgpack-rpc</pre>
<p>
See hackageDB page (<a href="http://hackage.haskell.org/package/msgpack">msgpack</a>, <a href="http://hackage.haskell.org/package/msgpack-rpc">msgpack-rpc</a>) for details.
</p>
</div>
<div class="box3" style="height:6em;">
<h3>C#</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+C+Sharp">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>D</h3>
<p class="getstart_links">
<a href="https://bitbucket.org/repeatedly/msgpack4d/">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>Erlang</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Erlang">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>Scala</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Scala">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>Go</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Go">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>JavaScript</h3>
<p class="getstart_links">
<a href="https://github.com/uupaa/msgpack.js/">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>Lua</h3>
<p class="getstart_links">
<a href="https://github.com/nobu-k/mplua">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>Node.JS</h3>
<p class="getstart_links">
<a href="https://github.com/pgriess/node-msgpack">Quick Start</a>
</p>
</div>
<div class="box3" style="height:6em;">
<h3>OCaml</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+OCaml">Quick Start</a>
</p>
</div>
<div class="box3" style="height:7em;">
<h3>PHP</h3>
<p class="getstart_links">
<a href="http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+PHP">Quick Start</a>
</p>
</div>
<!--
<p id="getstart_more_link"><a href="http://wiki.msgpack.org/display/MSGPACK/Home">And more...</a></p>
<p id="getstart_more_link"><a href="javascript:void(0)" onclick="$('#getstart_more_link').slideUp(300); $('#getstart_more').slideDown(300); return false;">And more...</a></p>
-->
</div>
<div id="more" class="container">
<h2 id="LearnMore">Learn More</h2>
<div id="doctoc" class="clearfix">
<div class="box3">
<h3><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+Serialization">Serialize Design</a></h3>
<p>More details about design of MessagePack-RPC.</p>
</div>
<div class="box3">
<h3><a href="http://wiki.msgpack.org/display/MSGPACK/Design+of+RPC">RPC Design</a></h3>
<p>More details about design of MessagePack.</p>
</div>
<div class="box3">
<h3><a href="http://wiki.msgpack.org/display/MSGPACK/ArticlesAndPresentations">Articles and Presentations</a></h3>
<p>Articles and slides about the designs and comparisons.</p>
</div>
<div class="box3">
<h3><a href="http://wiki.msgpack.org/display/MSGPACK/Format+specification">Serialize Spec</a></h3>
<p>MessagePack format specification.</p>
</div>
<div class="box3">
<h3><a href="http://wiki.msgpack.org/display/MSGPACK/RPC+specification">RPC Spec</a></h3>
<p>MessagePack-RPC protocol specification.</p>
</div>
<!--
<div class="box3">
<h3><a href="http://redmine.msgpack.org/projects/msgpack/wiki/QuickStartIDL">IDL Quick Start</a></h3>
<p>Start MessagePack-RPC Interface Definition Language.</p>
</div>
-->
</div>
<div class="box2l" style="height:26em;">
<!--<h3><a href="http://redmine.msgpack.org/projects/msgpack/wiki/MailingLists">Mailing Lists</a></h3>-->
<h3>Mailing Lists</h3>
<p>If you use MessagePack, please subscribe to the MessagePack mailing list. If you'd like to contribute to MessagePack, please subscribe to the MessagePack developers mailing list.</p>
<div id="groups">
<hr />
<table border="0" style="background-color: #fff; padding: 5px;" cellspacing="0">
<tr><td>
<img src="http://groups.google.com/intl/en/images/logos/groups_logo_sm.gif" height="30" width="140" alt="Google Groups" />
</td></tr>
<tr><td style="padding-left: 5px">
<b>Subscribe to MessagePack</b>
</td></tr>
<form action="http://groups.google.com/group/msgpack/boxsubscribe">
<tr><td style="padding-left: 5px;">
Email: <input type="text" name="email" />
<input type="submit" name="sub" value="Subscribe" />
</td></tr>
</form>
<tr><td align="right">
<a href="http://groups.google.com/group/msgpack">Visit this group</a>
</td></tr>
</table>
<hr />
<table border="0" style="background-color: #fff; padding: 5px;" cellspacing="0">
<tr><td>
<img src="http://groups.google.com/intl/en/images/logos/groups_logo_sm.gif" height="30" width="140" alt="Google Groups" />
</td></tr>
<tr><td style="padding-left: 5px">
<b>Subscribe to MessagePack Developers</b>
</td></tr>
<form action="http://groups.google.com/group/msgpack-dev/boxsubscribe">
<tr><td style="padding-left: 5px;">
Email: <input type="text" name="email" />
<input type="submit" name="sub" value="Subscribe" />
</td></tr>
</form>
<tr><td align="right">
<a href="http://groups.google.com/group/msgpack-dev">Visit this group</a>
</td></tr>
</table>
</div>
</div>
<div class="box2l" style="height:7.5em;">
<!--<h3><a href="http://redmine.msgpack.org/projects/msgpack/wiki/IRC">Chat</a></h3>-->
<h3>Chat</h3>
<p>Many of the MessagePack developers and community members hang out in the <strong>#msgpack</strong> channel on <a href="http://freenode.net/">irc.freenode.net</a>. If you are new to IRC and don't have a client, you can use a <a href="http://webchat.freenode.net/?channels=#msgpack">web-based client</a>.</p>
</div>
<div class="box2l" style="height:6em;">
<h3><a href="http://jira.msgpack.org/">Issues</a></h3>
<p>Issues are managed on <a href="http://jira.msgpack.org/browse/MSGPACK">JIRA</a>. Note that you need to create an account on the <a href="http://jira.msgpack.org/secure/Signup!default.jspa">registration page</a> to add issues.</p>
</div>
<div class="box2l" style="height:4em;">
<h3>Sources</h3>
<p>Sources are located at github. Send pull requests to <a href="http://github.com/msgpack">msgpack account</a>.</p>
<ul>
<li><a href="http://github.com/msgpack/msgpack">MessagePack repository at github</a></li>
<li><a href="http://github.com/msgpack/msgpack-rpc">MessagePack-RPC repository at github</a></li>
</ul>
</div>
</div>
<div id="footer">
<div class="container">
<div id="footerlogo"><a href="http://sourceforge.net/projects/msgpack"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=289834&type=13" width="120" height="30" alt="Get MessagePack at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a></div>
<p>Copyright © 2010 FURUHASHI Sadayuki. Licensed under the Apache License, Version 2.0.</p>
</div>
</div>
</body>
</html>