Generic microservice interfaces. More...

#include "gate/tech/gate_tech_api.h"
#include "gate/strings.h"
#include "gate/objects.h"
#include "gate/properties.h"
#include "gate/values.h"

Macros
#define	GATE_MICROSERVICE_STATUS_UNKNOWN 0x00
#define	GATE_MICROSERVICE_STATUS_OFFLINE 0x01
#define	GATE_MICROSERVICE_STATUS_ONLINE 0x02
#define	GATE_MICROSERVICE_STATUS_ERROR 0x04
#define	GATE_MICROSERVICE_STATUS_SWITCHING 0x08
#define	GATE_MICROSERVICE_STATUS_STARTING (GATE_MICROSERVICE_STATUS_SWITCHING \| GATE_MICROSERVICE_STATUS_ONLINE)
#define	GATE_MICROSERVICE_STATUS_STOPPING (GATE_MICROSERVICE_STATUS_SWITCHING \| GATE_MICROSERVICE_STATUS_OFFLINE)
#define	GATE_MICROSERVICE_STATUS_CONFIGURE 0x10
#define	GATE_MICROSERVICE_CONDITION_INITIALIZING 0x0001
#define	GATE_MICROSERVICE_CONDITION_INIT_ERROR 0x0002
#define	GATE_MICROSERVICE_CONDITION_PARAM_ERROR 0x0004
#define	GATE_MICROSERCICE_CONDITION_ACCESS_ERROR 0x0008
#define	GATE_MICROSERVICE_CONDITION_FULL_OPERATIONAL 0x0100
#define	GATE_MICROSERVICE_CONDITION_PARTIAL_OPERATIONAL 0x0200
#define	GATE_MICROSERVICE_CONDITION_DISCONNECTED 0x0400
#define	GATE_MICROSERVICE_CONDITION_TEMPORARY_DOWN 0x0800
#define	GATE_MICROSERVICE_CONDITION_MALFUNCTION 0x1000

Functions
	GATE_INTERFACE (gate_microservice)

Detailed Description

Generic microservice interfaces.

Macro Definition Documentation

◆ GATE_MICROSERVICE_STATUS_UNKNOWN

#define GATE_MICROSERVICE_STATUS_UNKNOWN 0x00

service is in unknown state

◆ GATE_MICROSERVICE_STATUS_OFFLINE

#define GATE_MICROSERVICE_STATUS_OFFLINE 0x01

service is stopped

◆ GATE_MICROSERVICE_STATUS_ONLINE

#define GATE_MICROSERVICE_STATUS_ONLINE 0x02

service is running

◆ GATE_MICROSERVICE_STATUS_ERROR

#define GATE_MICROSERVICE_STATUS_ERROR 0x04

service is in error state

◆ GATE_MICROSERVICE_STATUS_SWITCHING

#define GATE_MICROSERVICE_STATUS_SWITCHING 0x08

service is currently in status switching mode

◆ GATE_MICROSERVICE_STATUS_STARTING

#define GATE_MICROSERVICE_STATUS_STARTING (GATE_MICROSERVICE_STATUS_SWITCHING | GATE_MICROSERVICE_STATUS_ONLINE)

service is switching from offline to running

◆ GATE_MICROSERVICE_STATUS_STOPPING

#define GATE_MICROSERVICE_STATUS_STOPPING (GATE_MICROSERVICE_STATUS_SWITCHING | GATE_MICROSERVICE_STATUS_OFFLINE)

service is switching from running to offline

◆ GATE_MICROSERVICE_STATUS_CONFIGURE

#define GATE_MICROSERVICE_STATUS_CONFIGURE 0x10

service is reconfigured

◆ GATE_MICROSERVICE_CONDITION_INITIALIZING

#define GATE_MICROSERVICE_CONDITION_INITIALIZING 0x0001

service is initializing, other status values may be wrong

◆ GATE_MICROSERVICE_CONDITION_INIT_ERROR

#define GATE_MICROSERVICE_CONDITION_INIT_ERROR 0x0002

initialization has failed, service possible malfunctioning

◆ GATE_MICROSERVICE_CONDITION_PARAM_ERROR

#define GATE_MICROSERVICE_CONDITION_PARAM_ERROR 0x0004

parameter values are invalid, service possible malfunctioning

◆ GATE_MICROSERCICE_CONDITION_ACCESS_ERROR

#define GATE_MICROSERCICE_CONDITION_ACCESS_ERROR 0x0008

access to a required resource was denied, service possible malfunctioning

◆ GATE_MICROSERVICE_CONDITION_FULL_OPERATIONAL

#define GATE_MICROSERVICE_CONDITION_FULL_OPERATIONAL 0x0100

service is fully functional

◆ GATE_MICROSERVICE_CONDITION_PARTIAL_OPERATIONAL

#define GATE_MICROSERVICE_CONDITION_PARTIAL_OPERATIONAL 0x0200

service is partially functional, some features are unavailable

◆ GATE_MICROSERVICE_CONDITION_DISCONNECTED

#define GATE_MICROSERVICE_CONDITION_DISCONNECTED 0x0400

service is disconnected from a required resource

◆ GATE_MICROSERVICE_CONDITION_TEMPORARY_DOWN

#define GATE_MICROSERVICE_CONDITION_TEMPORARY_DOWN 0x0800

service is temporary unavailable but tries to recover

◆ GATE_MICROSERVICE_CONDITION_MALFUNCTION

#define GATE_MICROSERVICE_CONDITION_MALFUNCTION 0x1000

service is failing

Function Documentation

◆ GATE_INTERFACE()

GATE_INTERFACE ( gate_microservice )

< connects service with a host

< returns service address

< get internal operational status flags

< deliver a communication message

< deliver a communication object

< execute a remote procedure call

< return all supported parameter names

< return the property data type of a parameter

< return a parameter as a property value

< update a parameter with a property value

Macros

Functions