clients

Documentation

Overview

Generic client interface, used to describe an abstract client, whether it be an execution client or a consensus client

Index

• type Client
• type ExternalClient
  • func ExternalClientFromURL(url string, typ string) (*ExternalClient, error)
  • func (m *ExternalClient) ClientType() string
  • func (m *ExternalClient) GetAddress() string
  • func (m *ExternalClient) GetEnodeURL() (string, error)
  • func (m *ExternalClient) GetHost() string
  • func (m *ExternalClient) GetIP() net.IP
  • func (m *ExternalClient) GetPort() *int64
  • func (m *ExternalClient) IsRunning() bool
• type ManagedClient

Types

type Client

type Client interface {
	IsRunning() bool
	GetAddress() string
	GetHost() string
	GetIP() net.IP
	ClientType() string
}

type ExternalClient

type ExternalClient struct {
	Type     string
	Address  string
	Host     string
	IP       net.IP
	Port     *int64
	EnodeURL string
}

func ExternalClientFromURL

func ExternalClientFromURL(url string, typ string) (*ExternalClient, error)

func (*ExternalClient) ClientType

func (m *ExternalClient) ClientType() string

func (*ExternalClient) GetAddress

func (m *ExternalClient) GetAddress() string

func (*ExternalClient) GetEnodeURL

func (m *ExternalClient) GetEnodeURL() (string, error)

func (*ExternalClient) GetHost

func (m *ExternalClient) GetHost() string

func (*ExternalClient) GetIP

func (m *ExternalClient) GetIP() net.IP

func (*ExternalClient) GetPort

func (m *ExternalClient) GetPort() *int64

func (*ExternalClient) IsRunning

func (m *ExternalClient) IsRunning() bool

type ManagedClient

type ManagedClient interface {
	Client
	AddStartOption(...interface{})
	Start() error
	Shutdown() error
}