pakt

PAKT - Interlink Remote Applications

PAKT provides access to exported methods across a network or other I/O connections similar to RPC. It handles any I/O connection which implements the golang net.Conn interface. This library handles synchronization, heartbeat, encoding/decoding using MessagePack (or a custom codec) and ensures thread-safety.

Project Name

"Pakt" is the German word for pact (deal). Server and client make a pact and start communicating.

Documentation

See the documentation at GoDoc.

Protocol Specification

See the protocol specification.

Sample

Check the sample directory for a simple server and client example.

Introduction

Create a PAKT socket:

// Create a socket by passing a net.Conn interface.
s := pakt.NewSocket(conn)

Register a function callable from remote peers:

// Register the function.
s.RegisterFunc("foo", foo)

// ...

func foo(c *pakt.Context) (interface{}, error) {
    data := ... // A struct, string, ...

	// Decode the received data from the peer.
	err := c.Decode(&data)
	if err != nil {
		// The remote peer would get this error.
		return nil, err
	}

	// Just send the data back to the client.
	return data, nil
}

Call the remote function from a remote peer:

c, err := s.Call("foo", data)
if err != nil {
    // Handle error. This includes errors returned from the remote function.
}

// Decode the received data from the peer if it returns a data value.
err = c.Decode(&data)
if err != nil {
    // Handle error.
}