xmlrpc

README

XML-RPC Library

This is a simple XML-RPC client implementation. There is also a basic server part that can be used for callbacks.

Usage

Import via

gitlab.com/bboehmke/go-xmlrpc

then create a client and do a RPC call to a server:

// create client
client, err := xmlrpc.NewClient("https://mxl-rpc.server")

// send request
response, err := client.Call("system.listMethods")

For the detailed usage see the API doc.

Documentation

Index

• type Client
  • func NewClient(url string, opts ...Option) Client
• type Fault
• type Handler
• type Option
  • func HttpClient(httpClient *http.Client) Option
• type Request
  • func (r Request) MarshalXML(e *xml.Encoder, start xml.StartElement) error
• type Response
  • func (r *Response) DecodeParam(idx int, val interface{}) error
  • func (r *Response) FirstParam() interface{}
  • func (r *Response) MarshalXML(e *xml.Encoder, start xml.StartElement) error
• type Server
  • func NewServer(handler Handler) (*Server, error)
  • func (s *Server) IsRunning() bool
  • func (s *Server) Port() int
  • func (s *Server) ServeHTTP(writer http.ResponseWriter, request *http.Request)
  • func (s *Server) Start()
  • func (s *Server) Stop() error

Types

type Client

type Client interface {
	Call(method string, params ...interface{}) (*Response, error)
	LocalIP() (string, error)
}

Client interface for XML RPC client

func NewClient

func NewClient(url string, opts ...Option) Client

NewClient creates new client

type Fault

type Fault struct {
	Code   int32
	String string
}

Fault information of response

type Handler

type Handler func(method string, params []interface{}) ([]interface{}, *Fault)

Handler for received RPC request

type Option

type Option func(client *client)

Option defines a function that configures a Client by mutating it

func HttpClient

func HttpClient(httpClient *http.Client) Option

HttpClient option allows setting custom HTTP Client

type Request

type Request struct {
	Method string
	Params []interface{}
}

Request for XML RPCs

func (Request) MarshalXML

func (r Request) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML convert request to XML

type Response

type Response struct {
	Params []interface{}
	Fault  *Fault
}

Response of XML RPCs

func (*Response) DecodeParam

func (r *Response) DecodeParam(idx int, val interface{}) error

DecodeParam to the given value

func (*Response) FirstParam

func (r *Response) FirstParam() interface{}

FirstParam returns the first parameter or nil

func (*Response) MarshalXML

func (r *Response) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML convert response to XML

type Server

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

Server for XML RPC events

func NewServer

func NewServer(handler Handler) (*Server, error)

NewServer creates new server

func (*Server) IsRunning

func (s *Server) IsRunning() bool

IsRunning returns true if server is running

func (*Server) Port

func (s *Server) Port() int

Port of http server

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(writer http.ResponseWriter, request *http.Request)

ServeHTTP handles received requests

func (*Server) Start

func (s *Server) Start()

Start server

func (*Server) Stop

func (s *Server) Stop() error

Stop server