clientcmd

Documentation

Index

• type CreateClientCommand
• type DeleteClientCommand
• type Handler
  • func (h *Handler) CreateClient(ctx context.Context, cmd cbus.Command) (interface{}, error)
  • func (h *Handler) DeleteClient(ctx context.Context, cmd cbus.Command) (interface{}, error)
  • func (h *Handler) UpdateClient(ctx context.Context, cmd cbus.Command) (interface{}, error)
• type UpdateClientCommand

Types

type CreateClientCommand

type CreateClientCommand struct {
	//Name is the name of the Client to create.
	Name string
}

CreateClientCommand is Command that should be used to create a new Client and add it to a repository.

type DeleteClientCommand

type DeleteClientCommand struct {
	//Id is the Id of the Client to delete.
	Id data.Id
}

DeleteClientCommand is a Command to delete (remove) a Client.

type Handler

type Handler struct {
	//Clients is the Client repository to use within Command handling.
	Clients client.Repo
}

Handler is a handler type that understands how to work with Client commands.

func (*Handler) CreateClient

func (h *Handler) CreateClient(ctx context.Context, cmd cbus.Command) (interface{}, error)

CreateClient attempts to create a new Client and add it to h.Clients. Cmd must be of type *CreateClientCommand. The result, if not nil and without error, will be a *client.Client.

func (*Handler) DeleteClient

func (h *Handler) DeleteClient(ctx context.Context, cmd cbus.Command) (interface{}, error)

DeleteClient attempts to remove a Client from h.Clients. Cmd must be of type *DeleteClientCommand. The result will always be nil. A non-nil error will be returned to indicate failure.

func (*Handler) UpdateClient

func (h *Handler) UpdateClient(ctx context.Context, cmd cbus.Command) (interface{}, error)

UpdateClient attempts to retrieve and set a Client using h.Clients. Cmd must be of type *UpdateClientCommand. The result, if not nil and without error, will be a *client.Client.

type UpdateClientCommand

type UpdateClientCommand struct {
	//Id is the Id of the Client to update.
	Id data.Id

	//Name, if not nil, is the name to set on the Client.
	Name *string
}

UpdateClientCommand is a Command to update a Client.