Documentation

Overview

    Package handling provides the use-case for registering incidents. Used by views facing the people handling the cargo along its route.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var ErrInvalidArgument = errors.New("invalid argument")

      ErrInvalidArgument is returned when one or more arguments are invalid.

      Functions

      func MakeHandler

      func MakeHandler(hs Service, logger kitlog.Logger) http.Handler

        MakeHandler returns a handler for the handling service.

        Types

        type EventHandler

        type EventHandler interface {
        	CargoWasHandled(cargo.HandlingEvent)
        }

          EventHandler provides a means of subscribing to registered handling events.

          func NewEventHandler

          func NewEventHandler(s inspection.Service) EventHandler

            NewEventHandler returns a new instance of a EventHandler.

            type Service

            type Service interface {
            	// RegisterHandlingEvent registers a handling event in the system, and
            	// notifies interested parties that a cargo has been handled.
            	RegisterHandlingEvent(completed time.Time, id cargo.TrackingID, voyageNumber voyage.Number,
            		unLocode location.UNLocode, eventType cargo.HandlingEventType) error
            }

              Service provides handling operations.

              func NewInstrumentingService

              func NewInstrumentingService(counter metrics.Counter, latency metrics.Histogram, s Service) Service

                NewInstrumentingService returns an instance of an instrumenting Service.

                func NewLoggingService

                func NewLoggingService(logger log.Logger, s Service) Service

                  NewLoggingService returns a new instance of a logging Service.

                  func NewService

                    NewService creates a handling event service with necessary dependencies.