heartbeat

Documentation

Index

• type Client
  • func NewClient(config urlfinder.ClientConfig) Client
  • func NewClientWithBasicAuth(username, password string, config urlfinder.ClientConfig) (Client, error)
• type MockClient
  • func (m *MockClient) SendPulse(sessionID int) error
• type Pulse

Types

type Client

type Client interface {
	abstract.AbstractClient
	SendPulse(sessionID int) error
}

Client is an interface that contains an AbstractClient and a SendPulse method

func NewClient

func NewClient(config urlfinder.ClientConfig) Client

NewClient is a function that returns a new Client

func NewClientWithBasicAuth

func NewClientWithBasicAuth(username, password string, config urlfinder.ClientConfig) (Client, error)

NewClientWithBasicAuth is a function that returns a new Client using basic auth for the platform client

type MockClient

type MockClient struct {
	abstract_client.MockAbstractClient
	NumCalledPulse int
	PulseError     error
}

func (*MockClient) SendPulse

func (m *MockClient) SendPulse(sessionID int) error

SendPulse is a method that increments the number of times it was called and returns an error if PulseError is not nil

type Pulse

type Pulse struct {
	SessionID int `json:"sessionId"`
}

Pulse is a struct that represents a pulse sent to the heartbeat service.