QuickStart for Scala

h2. How to build

1. Build MessagePack for Java because MessagePack for scala depends on it.

{code}
$ cd java
$ mvn install
{code}

2. Build MessagePack for scala.

by meven

{code}
$ cd ../scala
$ mvn install && mvn package
{code}

or by sbt

{code}
$sbt
>> update
>> install
{code}

{code}
>> sbt update run
{code}
_sbt-launcher.jar is not included.Please install sbt by yourself._

h2. Getting started

Do you want more sample code?You see org.msgpack.UsageTest which is contained in github repository.

h3. 1.Use in normal way.
{code}
import org.msgpack._
import org.msgpack.annotation.Message
import org.msgpack.ScalaMessagePack._ // <- import MessagePack instance for scala

@Message
class SampleClass {
var name : String = "hoge"
var number : Int = 2
}

object Sample {
def main( args : Array[String]){

val sc = new SampleClass()
sc.name = "Test object"
sc.number = 123456
// using imported method from ScalaMessagePack
val b : Array[Byte] = write(sc) // or pack(sc) <- this is synonym.

val deser = read[SampleClass](b) // or unpack[SampleClass](sc)

println(deser.name)
println(deser.number)
}
}
{code}
Output is:
{code}
Test object
123456
{code}

h3. 2.Use with Value
{code}
import org.msgpack._
import org.msgpack.annotation.Message
import org.msgpack.ScalaMessagePack._ // <- ScalaMessagePack has implicit conversions


@Message
class SampleClass {
var name : String = "hoge"
var number : Int = 2
}

object Sample {
def main( args : Array[String]){

val sampleClassLike = List("sampleClassName",5)

val b = writeV(sampleClassLike) // sampleClassLike is converted to org.msgpack.type.Value implicitly.

// deserialize as Value
val value = readAsValue(b)

// you can access values easily
val name : String = value(0)
val number : Int = value(1)
println("Name:%s Number:%s".format(name,number))


// and it is also ok to deserialize to a same structure object.
val deser = read[SampleClass](b)
println("Name:%s Number:%s".format(deser.name,deser.number))
}
}
{code}
Output is:
{code}
Name:sampleClassName Number:5
Name:sampleClassName Number:5
{code}

h2. Use RPC

MessagePack for scala use java's rpc library.But you must be careful to use it.

{code}
<dependency>
<groupId>org.msgpack</groupId>
<artifactId>msgpack-rpc</artifactId>
<version>0.7.0-SNAPSHOT<!-- use correct version --></version>
</dependency>
{code}

h3. 1. Init Server
{code}
import org.msgpack.ScalaMessagePack
import org.msgpack.rpc.Server
import org.msgpack.rpc.loop.EventLoop


val loop = EventLoop.start( new ScalaMessagePack() /* or ScalaMessagePack.messagePack */) // you must pass MessagePack object

val server = new Server(loop)

server.serve( new MessagePackServer())

server.listen(port)
{code}

h3. 2. Init client
{code}
import org.msgpack.ScalaMessagePack
import org.msgpack.rpc.Client
import org.msgpack.rpc.loop.EventLoop

val loop = new EventLoop( new ScalaMessagePack() /* or ScalaMessagePack.messagePack */) // you must pass MessagePack object

val client = new Client(host,port,loop)

val proxy = client.proxy( classOf[MessagePackServerTrait])
{code}

h1. Known problem