errors

Documentation

Index

• Variables
• func AsHandlerError(service, procedure string, err error) error
• func ClientTimeoutError(Service string, Procedure string, Duration time.Duration) error
• func CombineErrors(errors ...error) error
• func HandlerTimeoutError(Caller string, Service string, Procedure string, Duration time.Duration) error
• func MissingParameters(params []string) error
• func MultiError(errors []error) error
• type BadRequestError
  • func RemoteBadRequestError(message string) BadRequestError
• type ErrOutboundNotStarted
  • func (e ErrOutboundNotStarted) Error() string
• type ErrorGroup
  • func (e ErrorGroup) Error() string
  • func (e ErrorGroup) IfAny() error
• type HandlerError
  • func HandlerBadRequestError(err error) HandlerError
  • func HandlerUnexpectedError(err error) HandlerError
• type ProcedureFailedError
  • func (e ProcedureFailedError) AsHandlerError() HandlerError
  • func (e ProcedureFailedError) Error() string
• type RemoteTimeoutError
  • func (e RemoteTimeoutError) Error() string
• type TimeoutError
• type UnexpectedError
  • func RemoteUnexpectedError(message string) UnexpectedError
• type UnrecognizedProcedureError
  • func (e UnrecognizedProcedureError) AsHandlerError() HandlerError
  • func (e UnrecognizedProcedureError) Error() string
• type UnsupportedTypeError
  • func (e UnsupportedTypeError) Error() string

Variables

var ErrNoRouter = errors.New("no router configured for transport inbound")

ErrNoRouter indicates that Start was called without first calling SetRouter for an inbound transport.

Functions

func AsHandlerError

func AsHandlerError(service, procedure string, err error) error

AsHandlerError converts an error into a HandlerError, leaving it unchanged if it is already one.

func ClientTimeoutError

func ClientTimeoutError(Service string, Procedure string, Duration time.Duration) error

ClientTimeoutError constructs an instance of a TimeoutError representing a timeout that occurred while the client was waiting during a request to a remote handler. It includes the service, procedure and duration waited.

func CombineErrors

func CombineErrors(errors ...error) error

CombineErrors combines the given collection of errors together. nil values will be ignored.

The intention for this is to help chain togeter errors from multiple failing operations.

CombineErrors(
	reader.Close(),
	writer.Close(),
)

This may also be used like so,

err := reader.Close()
err = internal.CombineErrors(err, writer.Close())
if someCondition {
	err = internal.CombineErrors(err, transport.Close())
}

func HandlerTimeoutError

func HandlerTimeoutError(Caller string, Service string, Procedure string, Duration time.Duration) error

HandlerTimeoutError constructs an instance of a TimeoutError representing a timeout that occurred during the handler execution, with the caller, service, procedure and duration waited.

func MissingParameters

func MissingParameters(params []string) error

MissingParameters returns an error representing a failure to process a request because it was missing required parameters.

func MultiError

func MultiError(errors []error) error

MultiError combines a list of errors into one. The list MUST NOT contain nil.

Returns nil if the error list is empty.

Types

type BadRequestError

type BadRequestError interface {
	error
	// contains filtered or unexported methods
}

BadRequestError is a failure to process a request because the request was invalid.

func RemoteBadRequestError

func RemoteBadRequestError(message string) BadRequestError

RemoteBadRequestError builds a new BadRequestError with the given message.

It represents a BadRequest failure from a remote service.

type ErrOutboundNotStarted

type ErrOutboundNotStarted string

ErrOutboundNotStarted represents a failure because Start() was not called on an outbound or if Stop() was called.

func (ErrOutboundNotStarted) Error

func (e ErrOutboundNotStarted) Error() string

type ErrorGroup

type ErrorGroup []error

ErrorGroup represents a collection of errors.

func (ErrorGroup) Error

func (e ErrorGroup) Error() string

func (ErrorGroup) IfAny

func (e ErrorGroup) IfAny() error

IfAny returns nil if the error group is empty, the only error if there is only one, or the error group itself if there are more.

type HandlerError

type HandlerError interface {
	error
	// contains filtered or unexported methods
}

HandlerError represents handler errors on the handler side.

The general hierarchy we have is:

	BadRequestError                   HandlerError
	 |                                        |
	 +--------> handlerBadRequestError <------+
	 |                                        |
	 +--------> remoteBadRequestError         |
	                                          |
	UnexpectedError                           |
	 |                                        |
	 +--------> handlerUnexpectedError <------+
	 |                                        |
	 +--------> remoteUnexpectedError         |
	                                          |
	TimeoutError                              |
	 |                                        |
	 +--------> handlerTimeoutError <---------+
	 |
	 +--------> remoteTimeoutError
  |
	 +--------> clientTimeoutError

Only the handler versions of the error types are HandlerErrors. If a handler returns one of the remote or client version, they will be wrapped in a new UnexpectedError.

HandlerError represents error types that can be returned from a handler that the Inbound implementation MUST handle. The inbound implementation can then returns the remote version of the error to the user.

Currently, this includes BadRequestError, UnexpectedError and TimeoutError. Error types which know how to convert themselves into BadRequestError, UnexpectedError or TimeoutError may provide a `AsHandlerError() HandlerError` method.

func HandlerBadRequestError

func HandlerBadRequestError(err error) HandlerError

HandlerBadRequestError wraps the given error into a BadRequestError.

It represents a local failure while processing an invalid request.

func HandlerUnexpectedError

func HandlerUnexpectedError(err error) HandlerError

HandlerUnexpectedError wraps the given error into an UnexpectedError.

It represens a local failure while processing a request.

type ProcedureFailedError

type ProcedureFailedError struct {
	Service   string
	Procedure string
	Reason    error
}

ProcedureFailedError is a failure to execute a procedure due to an unexpected error.

func (ProcedureFailedError) AsHandlerError

func (e ProcedureFailedError) AsHandlerError() HandlerError

AsHandlerError for ProcedureFailedError.

func (ProcedureFailedError) Error

func (e ProcedureFailedError) Error() string

type RemoteTimeoutError

type RemoteTimeoutError string

RemoteTimeoutError represents a TimeoutError from a remote handler.

func (RemoteTimeoutError) Error

func (e RemoteTimeoutError) Error() string

type TimeoutError

type TimeoutError interface {
	error
	// contains filtered or unexported methods
}

TimeoutError indicates that an error occurred due to a context deadline over the course of a request over any transport.

type UnexpectedError

type UnexpectedError interface {
	error
	// contains filtered or unexported methods
}

UnexpectedError is a server failure due to unhandled errors. This can be caused if the remote server panics while processing the request or fails to handle any other errors.

func RemoteUnexpectedError

func RemoteUnexpectedError(message string) UnexpectedError

RemoteUnexpectedError builds a new UnexpectedError with the given message.

It represents an UnexpectedError from a remote service.

type UnrecognizedProcedureError

type UnrecognizedProcedureError struct {
	Service   string
	Procedure string
}

UnrecognizedProcedureError is a failure to process a request because the procedure and/or service name was unrecognized.

func (UnrecognizedProcedureError) AsHandlerError

func (e UnrecognizedProcedureError) AsHandlerError() HandlerError

AsHandlerError for UnrecognizedProcedureError.

func (UnrecognizedProcedureError) Error

func (e UnrecognizedProcedureError) Error() string

type UnsupportedTypeError

type UnsupportedTypeError struct {
	Transport string
	Type      string
}

UnsupportedTypeError is a failure to process a request because the RPC type is unknown to the transport

func (UnsupportedTypeError) Error

func (e UnsupportedTypeError) Error() string