subsystem

type NetworkRequestHandler interface {
	// UserTokenRequested will be called whenever a new
	// user connects and thus requires a token for interaction
	UserTokenRequested(nwi NetworkingInterface) (string, error)

	// UserInputProvided is called when new input from the user that
	// is identified by the token is available for processing
	UserInputProvided(nwi NetworkingInterface, token, input string) error

	// InvalidateUserToken will be called when the client wants to invalidate
	// a user token (e.g. a log off ocurred) or the user terminated the
	// connection.
	InvalidateUserToken(nwi NetworkingInterface, token string) error

	// IsValidToken has to return 'true' if the given token is valid and equals
	// to a still active token that was previously created.
	IsValidToken(token string) bool
}

type NetworkingInterface interface {

	// starts the NWI to await and pass over
	// requests
	Listen() error

	// stops the NWI and cancels all connections
	Close()

	// defines the handler that will take care of
	// incoming request
	SetHandler(handler NetworkRequestHandler)

	// RouteEvent will pass an event to the frontend that
	// registered for events of the given token.
	RouteEvent(token string, payload []byte) error
}