Skip to content

niltonkummer/go-msgpack

 
 

Repository files navigation

MsgPack library for Go (DEPRECATED)

DEPRECATED as of May 29, 2013. Please use github.com/ugorji/go/codec
which is significantly faster, cleaner, more correct and more complete.
See [https://github.com/ugorji/go/tree/master/codec#readme]

A complete redesign was done which accomodates multiple codec formats. It thus became necessary to create a new repository with a different name.

I hope to retire this repository anytime from July 1, 2013.

A log message will be printed out at runtime encouraging users to upgrade.

About go-msgpack

Implements:

[http://wiki.msgpack.org/display/MSGPACK/Format+specification]

To install:

go get github.com/ugorji/go-msgpack

It provides features similar to encoding packages in the standard library (ie json, xml, gob, etc).

Supports:

  • Standard Marshal/Unmarshal interface.
  • Support for all exported fields (including anonymous fields)
  • Standard field renaming via tags
  • Encoding from any value (struct, slice, map, primitives, pointers, interface{}, etc)
  • Decoding into pointer to any non-nil value (struct, slice, map, int, float32, bool, string, etc)
  • Decoding into a nil interface{}
  • Handles time.Time transparently (stores time as 2 element array: seconds since epoch and nanosecond offset)
  • Provides a Server and Client Codec so msgpack can be used as communication protocol for net/rpc.

API docs: http://godoc.org/github.com/ugorji/go-msgpack

Usage

    dec = msgpack.NewDecoder(r, nil)  
    err = dec.Decode(&v)  
    
    enc = msgpack.NewEncoder(w)  
    err = enc.Encode(v)  
    
    //methods below are convenience methods over functions above.  
    data, err = msgpack.Marshal(v)  
    err = msgpack.Unmarshal(data, &v, nil)  
    
    //RPC Server
    conn, err := listener.Accept()
    rpcCodec := msgpack.NewRPCServerCodec(conn, nil)
    rpc.ServeCodec(rpcCodec)

    //RPC Communication (client side)
    conn, err = net.Dial("tcp", "localhost:5555")  
    rpcCodec := msgpack.NewRPCClientCodec(conn, nil)  
    client := rpc.NewClientWithCodec(rpcCodec)  

About

MsgPack library for Go (DEPRECATED. move to github.com/ugorji/go/codec)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published