All Interfaces:

Main Interface:

REST Interface:

PubSub Interface:

Description

This is the Golang User, Device, and Service client library for the OpenChirp framework.

Structure

Top level functions

• User client interfaces are created using framework.StartUserClient()
• Device client interfaces are created using framework.StartDeviceClient()
• Service client interfaces are created using framework.StartServiceClient()

The Client class serves as the parent class of all the above client interfaces and should not be directly used. The purpose of the clients are to provide a single uniform interface for all OpenChirp functionality. The client libraries combine the OpenChirp REST and PubSub protocols into a single abstraction.

REST

The pure http rest interface is exposed as the Golang rest package.

PubSub

The pure pubsub(MQTT) interface is exposed as the Golang pubsub package.

Utilities

The utils package holds functions and data structures commonly used across applications interfacing with OpenChirp.