xmlrpc

Documentation

Overview

Package xmlrpc implements the XML-RPC protocol, in a variant fit for ROS.

Index

• type Client
  • func NewClient(host string, httpClient *http.Client) *Client
  • func (c *Client) Do(method string, paramsReq interface{}, paramsRes interface{}) error
• type ErrorRes
• type RequestRaw
  • func (rr *RequestRaw) Decode(req interface{}) error
• type Server
  • func NewServer(address string, writeTimeout time.Duration) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) Serve(handler func(*RequestRaw) interface{})
  • func (s *Server) URL(ip net.IP, zone string) string

Types

type Client

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

Client is a XML-RPC client.

func NewClient

func NewClient(host string, httpClient *http.Client) *Client

NewClient allocates a Client.

func (*Client) Do

func (c *Client) Do(method string, paramsReq interface{}, paramsRes interface{}) error

Do writes a request and reads a response.

type ErrorRes

type ErrorRes struct{}

ErrorRes is a special response that sends status code 400. in case of errors, the C++ implementation replies with <methodResponse><fault><value>..., a structure which would require additional parsing.

type RequestRaw

type RequestRaw struct {
	Method string
	// contains filtered or unexported fields
}

RequestRaw is a raw request.

func (*RequestRaw) Decode

func (rr *RequestRaw) Decode(req interface{}) error

Decode transforms a RequestRaw into a Request.

type Server

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

Server is a XML-RPC server.

func NewServer

func NewServer(address string, writeTimeout time.Duration) (*Server, error)

NewServer allocates a server.

func (*Server) Close

func (s *Server) Close() error

Close closes all the server resources.

func (*Server) Serve

func (s *Server) Serve(handler func(*RequestRaw) interface{})

Serve starts serving requests and waits until the server is closed.

func (*Server) URL

func (s *Server) URL(ip net.IP, zone string) string

URL returns the server URL.