clients

Documentation

Index

• func NewCommandClient(messageBus messaging.MessageClient, baseTopic string, timeout time.Duration) interfaces.CommandClient
• func NewCommandClientWithNameFieldEscape(messageBus messaging.MessageClient, baseTopic string, timeout time.Duration) interfaces.CommandClient
• type CommandClient
  • func (c *CommandClient) AllDeviceCoreCommands(_ context.Context, offset int, limit int) (responses.MultiDeviceCoreCommandsResponse, edgexErr.EdgeX)
  • func (c *CommandClient) DeviceCoreCommandsByDeviceName(_ context.Context, deviceName string) (responses.DeviceCoreCommandResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueGetCommandByName(ctx context.Context, deviceName string, commandName string, dsPushEvent bool, ...) (*responses.EventResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueGetCommandByNameWithQueryParams(_ context.Context, deviceName string, commandName string, ...) (*responses.EventResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueSetCommandByName(_ context.Context, deviceName string, commandName string, ...) (commonDTO.BaseResponse, edgexErr.EdgeX)
  • func (c *CommandClient) IssueSetCommandByNameWithObject(_ context.Context, deviceName string, commandName string, ...) (commonDTO.BaseResponse, edgexErr.EdgeX)

Functions

func NewCommandClient

func NewCommandClient(messageBus messaging.MessageClient, baseTopic string, timeout time.Duration) interfaces.CommandClient

NewCommandClient returns the command client with the disabled NameFieldEscape

func NewCommandClientWithNameFieldEscape

func NewCommandClientWithNameFieldEscape(messageBus messaging.MessageClient, baseTopic string, timeout time.Duration) interfaces.CommandClient

NewCommandClientWithNameFieldEscape returns the command client with the enabled NameFieldEscape

Types

type CommandClient

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

func (*CommandClient) AllDeviceCoreCommands

func (c *CommandClient) AllDeviceCoreCommands(_ context.Context, offset int, limit int) (responses.MultiDeviceCoreCommandsResponse, edgexErr.EdgeX)

func (*CommandClient) DeviceCoreCommandsByDeviceName

func (c *CommandClient) DeviceCoreCommandsByDeviceName(_ context.Context, deviceName string) (responses.DeviceCoreCommandResponse, edgexErr.EdgeX)

func (*CommandClient) IssueGetCommandByName

func (c *CommandClient) IssueGetCommandByName(ctx context.Context, deviceName string, commandName string, dsPushEvent bool, dsReturnEvent bool) (*responses.EventResponse, edgexErr.EdgeX)

func (*CommandClient) IssueGetCommandByNameWithQueryParams

func (c *CommandClient) IssueGetCommandByNameWithQueryParams(_ context.Context, deviceName string, commandName string, queryParams map[string]string) (*responses.EventResponse, edgexErr.EdgeX)

func (*CommandClient) IssueSetCommandByName

func (c *CommandClient) IssueSetCommandByName(_ context.Context, deviceName string, commandName string, settings map[string]string) (commonDTO.BaseResponse, edgexErr.EdgeX)

func (*CommandClient) IssueSetCommandByNameWithObject

func (c *CommandClient) IssueSetCommandByNameWithObject(_ context.Context, deviceName string, commandName string, settings map[string]any) (commonDTO.BaseResponse, edgexErr.EdgeX)