Server Initialization

These steps must first be performed in order to begin creating server objects of any variety.

Make an xxdk.Cmix Object

The xxdk.Cmix object created here will be used for all types of xxdk.Identity and server initialization.

1. Obtain the NDF

ndfJson, err := xxdk.DownloadAndVerifySignedNdfWithUrl(url, cert)

2. If not done in previous runs, create a new xxdk.Cmix object in storage using ndfJson. storageDir and password may be customized.

Example:

err := xxdk.NewCmix(ndfJson, "/clientStorage", []byte("testPassword"), "")

3. LoadCmix in order to obtain the xxdk.Cmix object. storageDir and password may be customized, but must match the values provided to NewCmix(). The result of xxdk.GetDefaultParams() may also be freely modified according to your needs.

Example:

client, err := xxdk.LoadCmix("/clientStorage", []byte("testPassword"), xxdk.GetDefaultParams())

4. Start the network follower. Timeout may be modified as needed.

Example:

err := client.StartNetworkFollower(10*time.Second)

Make an xxdk.Identity Object

The xxdk.Identity object created here will be used for all types of server initialization. It requires an xxdk.Cmix object.

Example:

identity, err := xxdk.MakeIdentity(client.GetRng(), client.GetStorage().GetE2EGroup())

Building Servers

Creating Connect-backed Servers

receptionId: the client ID that will be used for all incoming requests. Derived from xxdk.Identity object

privKey: the private key belonging to the receptionId. Derived from xxdk.Identity object

rng: from xxdk.Cmix object

grp: from xxdk.Cmix storage object

net: from xxdk.Cmix object

p: customizable parameters for the server Obtained and mutable via connect.GetDefaultParams()

Example:

server, err := connect.NewServer(myIdentity.ID, myIdentity.DHKeyPrivate, client.GetRng(), 
	client.GetStorage().GetE2EGroup(), client.GetCmix(), connect.GetDefaultParams())

Creating Single-backed Servers

receptionId: the client ID that will be used for all incoming requests. Derived from xxdk.Identity object

privKey: the private key belonging to the receptionId. Derived from xxdk.Identity object

grp: from xxdk.Cmix storage object

net: from xxdk.Cmix object

Example:

server, err := single.NewServer(myIdentity.ID, myIdentity.DHKeyPrivate, 
	client.GetStorage().GetE2EGroup(), client.GetCmix())

Adding Server Endpoints

Once you have a server object, you can begin adding Endpoints to process incoming client requests. See documentation in restlike/types.go for more information.

Example:

// Build a callback for the new endpoint
// The callback processes a restlike.Message and returns a restlike.Message response
cb := func(msg *Message) *Message {
    // Read the incoming restlike.Message and print its contents
    // NOTE: You may encode the msg.Contents in any way you like, as long as it matches on both sides.
    //       In this case, we're expecting a simple byte encoding.
    fmt.Printf("Incoming message: %s", string(msg.Content))
    // Return a friendly response to the incoming message 
    // NOTE: For responses, Content, Headers, and Error are the only meaningful fields
    return &restlike.Message{
		Content: []byte("Hello! Nice to meet you."),
		Headers: &restlike.Headers{
			Headers: nil,
			Version: 0,
		},
		Error: nil,
	}
}
// Add an endpoint that accepts 'restlike.Get' requests at the 'results' endpoint
server.GetEndpoints().Add("results", restlike.Get, cb)