rapi

package

v0.0.0-...-440f62f Latest Latest Go to latest Published: Sep 6, 2015 License: MIT Imports: 2 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

The rapi package contains the Go RPC method arguments and return values used by both the Forest Bus Server and Client implementations.

This package should not normally be used directly, instead please refer to the forestbus package for the library client.

View Source

const (
	RI_SUCCESS int = iota
	RI_MISMATCHED_CLUSTER_ID
	RI_TOPIC_NOT_FOUND
	RI_INTERNAL_ERROR
	RI_NODE_NOT_LEADER
	RI_NODE_IN_SHUTDOWN
)

View Source

var ERR_TOPIC_NOT_FOUND = errors.New("Topic not found on server.")

This section is empty.

type GetClusterDetailsArgs struct {
}

type GetClusterDetailsResults struct {
	Result    ResultInfo
	ClusterID string
	Peers     []string
	Topics    []string
}

type GetTopicDetailsArgs struct {
	Topic string
}

type GetTopicDetailsResults struct {
	Result      ResultInfo
	FirstIndex  int64
	LastIndex   int64
	CommitIndex int64
}

type ReceiveMessagesArgs struct {
	ClusterID       string
	Topic           string
	ID              int64
	Quantity        int
	WaitForMessages bool
}

type ReceiveMessagesResults struct {
	Result           ResultInfo
	ReceivedMessages [][]byte
	NextID           int64
}

type ResultInfo struct {
	Code        int
	Description string
	Extra1      string
}

func Get_RI_INTERNAL_ERROR(nodeName, errStr string, extra ...string) ResultInfo

func Get_RI_MISMATCHED_CLUSTER_ID(nodeName, givenID, configuredID string) ResultInfo

func Get_RI_NODE_IN_SHUTDOWN(nodeName string) ResultInfo

func Get_RI_NODE_NOT_LEADER(nodeName, actualLeader string) ResultInfo

func Get_RI_SUCCESS() ResultInfo

func Get_RI_TOPIC_NOT_FOUND(nodeName, givenTopic string) ResultInfo

type SendMessagesArgs struct {
	ClusterID     string
	Topic         string
	SentMessages  [][]byte
	WaitForCommit bool
}

type SendMessagesResults struct {
	Result ResultInfo
	IDs    []int64
}