apiparam

Documentation

Overview

Package apiparam implements the Parameter API.

https://wiki.ros.org/ROS/Parameter%20Server%20API

Index

• type Client
  • func NewClient(address string, callerID string, httpClient *http.Client) *Client
  • func (c *Client) DeleteParam(key string) error
  • func (c *Client) GetParamBool(key string) (bool, error)
  • func (c *Client) GetParamFloat64(key string) (float64, error)
  • func (c *Client) GetParamInt(key string) (int, error)
  • func (c *Client) GetParamNames() ([]string, error)
  • func (c *Client) GetParamString(key string) (string, error)
  • func (c *Client) HasParam(key string) (bool, error)
  • func (c *Client) SearchParam(key string) (string, error)
  • func (c *Client) SetParamBool(key string, val bool) error
  • func (c *Client) SetParamFloat64(key string, val float64) error
  • func (c *Client) SetParamInt(key string, val int) error
  • func (c *Client) SetParamString(key string, val string) error
• type RequestDeleteParam
• type RequestGetParam
• type RequestGetParamNames
• type RequestHasParam
• type RequestParamSetBool
• type RequestParamSetFloat64
• type RequestParamSetInt
• type RequestParamSetString
• type RequestSearchParam
• type ResponseDeleteParam
• type ResponseGetParamBool
• type ResponseGetParamFloat64
• type ResponseGetParamInt
• type ResponseGetParamNames
• type ResponseGetParamString
• type ResponseHasParam
• type ResponseSearchParam
• type ResponseSetParam

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a Parameter API client.

func NewClient

func NewClient(address string, callerID string, httpClient *http.Client) *Client

NewClient allocates a Client.

func (*Client) DeleteParam

func (c *Client) DeleteParam(key string) error

DeleteParam writes a deleteParam request.

func (*Client) GetParamBool

func (c *Client) GetParamBool(key string) (bool, error)

GetParamBool writes a getParam request and expects a bool response.

func (*Client) GetParamFloat64

func (c *Client) GetParamFloat64(key string) (float64, error)

GetParamFloat64 writes a getParam request and expects a float64 response.

func (*Client) GetParamInt

func (c *Client) GetParamInt(key string) (int, error)

GetParamInt writes a getParam request and expects a int response.

func (*Client) GetParamNames

func (c *Client) GetParamNames() ([]string, error)

GetParamNames writes a getParamNames request.

func (*Client) GetParamString

func (c *Client) GetParamString(key string) (string, error)

GetParamString writes a getParam request and expects a string response.

func (*Client) HasParam

func (c *Client) HasParam(key string) (bool, error)

HasParam writes a hasParam request.

func (*Client) SearchParam

func (c *Client) SearchParam(key string) (string, error)

SearchParam writes a searchParam request.

func (*Client) SetParamBool

func (c *Client) SetParamBool(key string, val bool) error

SetParamBool writes a setParam request.

func (*Client) SetParamFloat64

func (c *Client) SetParamFloat64(key string, val float64) error

SetParamFloat64 writes a setParam request.

func (*Client) SetParamInt

func (c *Client) SetParamInt(key string, val int) error

SetParamInt writes a setParam request.

func (*Client) SetParamString

func (c *Client) SetParamString(key string, val string) error

SetParamString writes a setParam request.

type RequestDeleteParam

type RequestDeleteParam struct {
	CallerID string
	Key      string
}

RequestDeleteParam is a deleteParam request.

type RequestGetParam

type RequestGetParam struct {
	CallerID string
	Key      string
}

RequestGetParam is a getParam request.

type RequestGetParamNames

type RequestGetParamNames struct {
	CallerID string
}

RequestGetParamNames is a getParamNames request.

type RequestHasParam

type RequestHasParam struct {
	CallerID string
	Key      string
}

RequestHasParam is a hasParam request.

type RequestParamSetBool

type RequestParamSetBool struct {
	CallerID string
	Key      string
	Val      bool
}

RequestParamSetBool is a setParam request.

type RequestParamSetFloat64

type RequestParamSetFloat64 struct {
	CallerID string
	Key      string
	Val      float64
}

RequestParamSetFloat64 is a setParam request.

type RequestParamSetInt

type RequestParamSetInt struct {
	CallerID string
	Key      string
	Val      int
}

RequestParamSetInt is a setParam request.

type RequestParamSetString

type RequestParamSetString struct {
	CallerID string
	Key      string
	Val      string
}

RequestParamSetString is a setParam request.

type RequestSearchParam

type RequestSearchParam struct {
	CallerID string
	Key      string
}

RequestSearchParam is a searchParam request.

type ResponseDeleteParam

type ResponseDeleteParam struct {
	Code          int
	StatusMessage string
	Ignore        int
}

ResponseDeleteParam is the response to a deleteParam request.

type ResponseGetParamBool

type ResponseGetParamBool struct {
	Code          int
	StatusMessage string
	Res           bool
}

ResponseGetParamBool is the response to a getParam request.

type ResponseGetParamFloat64

type ResponseGetParamFloat64 struct {
	Code          int
	StatusMessage string
	Res           float64
}

ResponseGetParamFloat64 is the response to a getParam request.

type ResponseGetParamInt

type ResponseGetParamInt struct {
	Code          int
	StatusMessage string
	Res           int
}

ResponseGetParamInt is the response to a getParam request.

type ResponseGetParamNames

type ResponseGetParamNames struct {
	Code          int
	StatusMessage string
	List          []string
}

ResponseGetParamNames is the response to a getParamNames request.

type ResponseGetParamString

type ResponseGetParamString struct {
	Code          int
	StatusMessage string
	Res           string
}

ResponseGetParamString is the response to a getParam request.

type ResponseHasParam

type ResponseHasParam struct {
	Code   int
	KeyOut string
	Res    bool
}

ResponseHasParam is the response to a hasParam request.

type ResponseSearchParam

type ResponseSearchParam struct {
	Code          int
	StatusMessage string
	FoundKey      string
}

ResponseSearchParam is the response to a searchParam request.

type ResponseSetParam

type ResponseSetParam struct {
	Code          int
	StatusMessage string
	Ignore        int
}

ResponseSetParam is the response to a setParam request.