common

type API interface {
	Post(interface{}) IElements
	Put(interface{}) IElements
	Patch(interface{}) IElements
	Delete(interface{}) IElements
	Get(string) IElements
}

type Action byte

type IComparator interface {
	Left() string
	LeftProperty() IProperty
	Right() string
	RightProperty() IProperty
	Operator() string
}

type ICondition interface {
	Comparator() IComparator
	Operator() string
	Next() ICondition
}

type IDatatListener interface {
	ShutdownVNic(IVirtualNetworkInterface)
	HandleData([]byte, IVirtualNetworkInterface)
	Failed([]byte, IVirtualNetworkInterface, string)
}

type IElements interface {
	Elements() []interface{}
	Keys() []interface{}
	Errors() []error
	Element() interface{}
	Query(IResources) (IQuery, error)
	Key() interface{}
	Error() error
	Serialize() ([]byte, error)
	Deserialize([]byte, IRegistry) error
}

type IExpression interface {
	Condition() ICondition
	Operator() string
	Next() IExpression
	Child() IExpression
}

type IInfo interface {
	Type() reflect.Type
	Name() string
	Serializer(SerializerMode) ISerializer
	AddSerializer(ISerializer)
	NewInstance() (interface{}, error)
}

type IIntrospector interface {
	Inspect(interface{}) (*types.RNode, error)
	Node(string) (*types.RNode, bool)
	NodeByType(p reflect.Type) (*types.RNode, bool)
	NodeByTypeName(string) (*types.RNode, bool)
	NodeByValue(interface{}) (*types.RNode, bool)
	Nodes(bool, bool) []*types.RNode
	Registry() IRegistry
	Kind(*types.RNode) reflect.Kind
	Clone(interface{}) interface{}
	TableView(string) (*types.TableView, bool)
	TableViews() []*types.TableView
}

type ILogger interface {
	Trace(...interface{})
	Debug(...interface{})
	Info(...interface{})
	Warning(...interface{})
	Error(...interface{}) error
	Empty() bool
	Fail(interface{}, ...interface{})
	SetLogLevel(LogLevel)
}

type IMessage interface {
	Source() string
	Vnet() string
	Destination() string
	ServiceArea() uint16
	ServiceName() string
	Sequence() uint32
	Priority() Priority
	Action() Action
	SetAction(Action)
	Timeout() uint16
	Request() bool
	Reply() bool
	FailMessage() string
	Data() string
	SetData(string)
	Tr() ITransaction
	SetTr(transaction ITransaction)
}

type IProperty interface {
	PropertyId() (string, error)
	Get(interface{}) (interface{}, error)
	Set(interface{}, interface{}) (interface{}, interface{}, error)
	Node() *types.RNode
	Parent() IProperty
	IsString() bool
}

type IQuery interface {
	RootType() *types.RNode
	Properties() []IProperty
	Criteria() IExpression
}

type IRegistry interface {
	//Register - receive as an input an instance and register, extract the Type and register it.
	Register(interface{}) (bool, error)
	//RegisterType - receive a reflect.Type instance and register it.
	RegisterType(reflect.Type) (bool, error)
	//Info Retrieve the registered entry for this type.
	Info(string) (IInfo, error)
	//Register Enum string to int32 values
	RegisterEnums(map[string]int32)
	//Get int32 value of an enum
	Enum(string) int32
}

type IResources interface {
	Registry() IRegistry
	ServicePoints() IServicePoints
	Security() ISecurityProvider
	DataListener() IDatatListener
	Serializer(SerializerMode) ISerializer
	Logger() ILogger
	SysConfig() *types.SysConfig
	Introspector() IIntrospector
	AddService(string, int32)
}

type ISecurityProvider interface {
	CanDial(string, uint32) (net.Conn, error)
	CanAccept(net.Conn) error
	ValidateConnection(net.Conn, *types.SysConfig) error

	Encrypt([]byte) (string, error)
	Decrypt(string) ([]byte, error)

	CanDoAction(Action, IElements, string, string, ...string) error
	ScopeView(IElements, string, string, ...string) IElements
	Authenticate(string, string, ...string) string
}

type ISerializer interface {
	Mode() SerializerMode
	Marshal(interface{}, IRegistry) ([]byte, error)
	Unmarshal([]byte, IRegistry) (interface{}, error)
}

type IServicePointHandler interface {
	Post(IElements, IResources) IElements
	Put(IElements, IResources) IElements
	Patch(IElements, IResources) IElements
	Delete(IElements, IResources) IElements
	GetCopy(IElements, IResources) IElements
	Get(IElements, IResources) IElements
	Failed(IElements, IResources, IMessage) IElements
	ServiceName() string
	ServiceModel() IElements
	EndPoint() string
	Transactional() bool
	ReplicationCount() int
	ReplicationScore() int
}

type IServicePoints interface {
	// Register A Service Point, handler + service area
	RegisterServicePoint(IServicePointHandler, uint16) error
	// Handle a message and forward to the handler
	Handle(IElements, Action, IVirtualNetworkInterface, IMessage, bool) IElements
	// Handle a notification message, massage it to a change set and forward to the handler
	Notify(IElements, IVirtualNetworkInterface, IMessage, bool) IElements
	// Return the service point handler for the service name and area
	ServicePointHandler(string, uint16) (IServicePointHandler, bool)
}

type ITransaction interface {
	Id() string
	State() TransactionState
	SetState(TransactionState)
	ErrorMessage() string
	SetErrorMessage(string)
	StartTime() int64
}

type IVirtualNetworkInterface interface {
	Start()
	Shutdown()
	Name() string
	SendMessage([]byte) error
	// Unicast a message without expecting response
	Unicast(string, string, uint16, Action, interface{}) error
	// Unicast a message expecting response
	Request(string, string, uint16, Action, interface{}) IElements
	// Reply to a Request
	Reply(IMessage, IElements) error
	// Multicast a message to all service name listeners, without expecting a response
	Multicast(string, uint16, Action, interface{}) error
	// Single a message to ONLY ONE service provider of the group,
	// not expecting a response. Provider is chosen by residency to the requester.
	Single(string, uint16, Action, interface{}) error
	// SingleRequest same as single but expecting a response
	SingleRequest(string, uint16, Action, interface{}) IElements
	// Leader Same as SingleRequest but sending always to the leader.
	Leader(string, uint16, Action, interface{}) IElements
	Forward(IMessage, string) IElements
	API(string, uint16) API
	Resources() IResources
}

type LogLevel int

type Priority byte

type SerializerMode int

type TransactionState uint8