Documentation
¶
Overview ¶
Package apimaster implements the Master API.
Index ¶
- type Client
- func (c *Client) GetPublishedTopics(subgraph string) ([][]string, error)
- func (c *Client) GetSystemState() (*SystemState, error)
- func (c *Client) GetTopicTypes() ([]TopicType, error)
- func (c *Client) GetURI() (string, error)
- func (c *Client) LookupNode(name string) (string, error)
- func (c *Client) LookupService(name string) (string, error)
- func (c *Client) RegisterPublisher(topic string, topicType string, callerURL string) ([]string, error)
- func (c *Client) RegisterService(service string, serviceURL string, callerURL string) error
- func (c *Client) RegisterSubscriber(topic string, topicType string, callerURL string) ([]string, error)
- func (c *Client) UnregisterPublisher(topic string, callerURL string) error
- func (c *Client) UnregisterService(service string, serviceURL string) error
- func (c *Client) UnregisterSubscriber(topic string, callerURL string) error
- type RequestGetPublishedTopics
- type RequestGetSystemState
- type RequestGetTopicTypes
- type RequestGetURI
- type RequestLookup
- type RequestRegister
- type RequestRegisterService
- type RequestUnregister
- type RequestUnregisterService
- type ResponseGetPublishedTopics
- type ResponseGetSystemState
- type ResponseGetTopicTypes
- type ResponseGetURI
- type ResponseLookup
- type ResponseRegister
- type ResponseRegisterService
- type ResponseServiceUnregister
- type ResponseUnregister
- type SystemState
- type SystemStateEntry
- type TopicType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a Master API client.
func (*Client) GetPublishedTopics ¶
GetPublishedTopics writes a getPublishedTopics request.
func (*Client) GetSystemState ¶
func (c *Client) GetSystemState() (*SystemState, error)
GetSystemState writes a getSystemState request.
func (*Client) GetTopicTypes ¶
GetTopicTypes writes a getTopicTypes request.
func (*Client) LookupNode ¶
LookupNode writes a lookupNode request.
func (*Client) LookupService ¶
LookupService writes a lookupService request.
func (*Client) RegisterPublisher ¶
func (c *Client) RegisterPublisher( topic string, topicType string, callerURL string, ) ([]string, error)
RegisterPublisher writes a registerPublisher request.
func (*Client) RegisterService ¶
RegisterService writes a registerService request.
func (*Client) RegisterSubscriber ¶
func (c *Client) RegisterSubscriber( topic string, topicType string, callerURL string, ) ([]string, error)
RegisterSubscriber writes a registerSubscriber request.
func (*Client) UnregisterPublisher ¶
UnregisterPublisher writes a unregisterPublisher request.
func (*Client) UnregisterService ¶
UnregisterService writes a unregisterService request.
type RequestGetPublishedTopics ¶
RequestGetPublishedTopics is a getPublishedTopics request.
type RequestGetSystemState ¶
type RequestGetSystemState struct {
CallerID string
}
RequestGetSystemState is a getSystemState request.
type RequestGetTopicTypes ¶
type RequestGetTopicTypes struct {
CallerID string
}
RequestGetTopicTypes is a getTopicTypes request.
type RequestGetURI ¶
type RequestGetURI struct {
CallerID string
}
RequestGetURI is a getUri request.
type RequestLookup ¶
RequestLookup is a lookup* request.
type RequestRegister ¶
RequestRegister is a register* request.
type RequestRegisterService ¶
type RequestRegisterService struct {
CallerID string
Service string
ServiceURL string
CallerURL string
}
RequestRegisterService is a registerService request.
type RequestUnregister ¶
RequestUnregister is an unregister* request.
type RequestUnregisterService ¶
RequestUnregisterService is a unregisterService request.
type ResponseGetPublishedTopics ¶
ResponseGetPublishedTopics is the response to a getPublishedTopics request.
type ResponseGetSystemState ¶
type ResponseGetSystemState struct {
Code int
StatusMessage string
State SystemState
}
ResponseGetSystemState is the response to a getSystemState request.
type ResponseGetTopicTypes ¶
ResponseGetTopicTypes is the response to a getTopicTypes request.
type ResponseGetURI ¶
ResponseGetURI is the response to a getUri request.
type ResponseLookup ¶
ResponseLookup is the response to a lookup* request.
type ResponseRegister ¶
ResponseRegister is the response to a register* request.
type ResponseRegisterService ¶
ResponseRegisterService is the response to a registerService request.
type ResponseServiceUnregister ¶
ResponseServiceUnregister is the response to a unregisterService request.
type ResponseUnregister ¶
ResponseUnregister is the response to a unregister* request.
type SystemState ¶
type SystemState struct {
PublishedTopics []SystemStateEntry
SubscribedTopics []SystemStateEntry
ProvidedServices []SystemStateEntry
}
SystemState is a system state.
type SystemStateEntry ¶
SystemStateEntry is a system state entry.