RallyHereGameInstanceAdapter Struct
Opaque type and handle to a Rally Here Game Instance Adapter. This struct is intentionally empty because its true interface is only defined internally. Any methods which take this as the first argument can be thought of as methods on this struct. Callbacks are either called immediately at the call site or when calling rallyhere_tick().## Summary
Kind | View | Description |
---|---|---|
RH_EXPORT void | rallyhere_set_log_callback(RallyHereGameInstanceAdapterPtr adapter, RallyHereLogCallback callback, void * user_data) | |
RH_EXPORT RallyHereStatusCode | rallyhere_create_game_instance_adapter(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments) | |
RH_EXPORT RallyHereStatusCode | rallyhere_create_game_instance_adaptern(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments, unsigned int arguments_length) | |
RH_EXPORT RallyHereStatusCode | rallyhere_create_game_instance_adapter_with_logger(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments, RallyHereLogCallback callback, void * user_data) | |
RH_EXPORT RallyHereStatusCode | rallyhere_create_game_instance_adaptern_with_logger(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments, unsigned int arguments_length, RallyHereLogCallback callback, void * user_data) | |
RH_EXPORT void | rallyhere_destroy_game_instance_adapter(RallyHereGameInstanceAdapterPtr adapter) | Destroys the adapter. |
RH_EXPORT RallyHereStatusCode | rallyhere_tick(RallyHereGameInstanceAdapterPtr adapter) | Tick that’s expected to be called every frame. |
RH_EXPORT RallyHereStatusCode | rallyhere_healthy(RallyHereGameInstanceAdapterPtr adapter) | Mark the adapter as healthy. |
RH_EXPORT void | rallyhere_connect(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Begin the process of connecting to the appropriate game host. |
RH_EXPORT void | rallyhere_ready(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Tell the game host that this GameInstance can now be allocated. |
RH_EXPORT void | rallyhere_on_allocated_callback(RallyHereGameInstanceAdapterPtr adapter, RallyHereOnAllocatedCallback callback, void * user_data) | |
RH_EXPORT void | rallyhere_test_fake_allocation_response(RallyHereGameInstanceAdapterPtr adapter, const char * fake_data) | |
RH_EXPORT void | rallyhere_allocate(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Tell the game host that this GameInstance has been allocated. |
RH_EXPORT void | rallyhere_reserve(RallyHereGameInstanceAdapterPtr adapter, unsigned int timeout_seconds, void(*)(const RallyHereStatusCode &code, void user_data) reserve_callback, void * reserve_user_data, void()(const RallyHereStatusCode &code, void *user_data) ready_callback, void * ready_user_data) | Tell the game host to reserve this game instance rather than marking it ready. |
RH_EXPORT void | rallyhere_reserve_unconditional(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Tell the game host to reserve this game instance rather than marking it ready. |
RH_EXPORT void | rallyhere_on_soft_stop_callback(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | The callback to trigger when the game host wants to stop the game instance. |
RH_EXPORT void | rallyhere_external_soft_stop_requested(RallyHereGameInstanceAdapterPtr adapter) | Inform the adapter that a soft stop has been requested. |
RH_EXPORT void | rallyhere_get_labels(RallyHereGameInstanceAdapterPtr adapter, RallyHereStringMapPtr * map) | Get the current string map for the labels. |
RH_EXPORT void | rallyhere_set_labels(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStringMapPtr map, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Set the current string map for the labels. |
RH_EXPORT void | rallyhere_get_additional_info(RallyHereGameInstanceAdapterPtr adapter, RallyHereStringMapPtr * map) | Get the current string map for the additional info. |
RH_EXPORT void | rallyhere_set_additional_info(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStringMapPtr map, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Set the current string map for the additional info. |
RH_EXPORT void | rallyhere_get_annotations(RallyHereGameInstanceAdapterPtr adapter, RallyHereStringMapPtr * map) | Get the current string map for the annotations. |
RH_EXPORT void | rallyhere_set_annotations(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStringMapPtr map, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Set the current string map for the annotations. |
RH_EXPORT RallyHereStatusCode | rallyhere_stats_base(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStatsBase * stats, const RallyHereStatsBaseProvided * provided, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | Set the base stats for the game instance. |
RH_EXPORT void | rallyhere_stats_gauge(RallyHereGameInstanceAdapterPtr adapter, const char * name, double value, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | |
RH_EXPORT void | rallyhere_stats_gauge_with_labels(RallyHereGameInstanceAdapterPtr adapter, const char * name, double value, const RallyHereStringMapPtr labels, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | |
RH_EXPORT void | rallyhere_stats_arbitrary(RallyHereGameInstanceAdapterPtr adapter, const char * name, const char * data, unsigned int data_size, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data) | |
RH_EXPORT void | rallyhere_stats_arbitrary_move(RallyHereGameInstanceAdapterPtr adapter, const char * name, char * data, unsigned int data_size, void(*)(const RallyHereStatusCode &code, char *data, void *user_data) callback, void * user_data) | |
RH_EXPORT RallyHereStatusCode | rallyhere_metrics_immediate_action(RallyHereGameInstanceAdapterPtr adapter, const RallyHereMetricDefinition * definition, const RallyHereMetricAction * action, RallyHereMetricFlush flush) | |
RH_EXPORT RallyHereStatusCode | rallyhere_metrics_immediate_action_with_time(RallyHereGameInstanceAdapterPtr adapter, const RallyHereMetricDefinition * definition, const RallyHereMetricAction * action, double timestamp, RallyHereMetricFlush flush) | |
RH_EXPORT void | rallyhere_metrics_statsd_output(RallyHereGameInstanceAdapterPtr adapter, const char ** data, size_t * data_size) | |
RH_EXPORT void | rallyhere_metrics_graphite_output(RallyHereGameInstanceAdapterPtr adapter, const char ** data, size_t * data_size) |
Logging
Logging levels that will passed to the optional log callback function
rallyhere_set_log_callback
RH_EXPORT void rallyhere_set_log_callback(RallyHereGameInstanceAdapterPtr adapter, RallyHereLogCallback callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
RallyHereLogCallback | callback |
void * | user_data |
Description
Sets a custom logger that can handle logs from inside of the server.
Lifetime
Manages the lifetime of a Rally Here Game Instance Adapter.
rallyhere_create_game_instance_adapter
RH_EXPORT RallyHereStatusCode rallyhere_create_game_instance_adapter(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr * | adapter |
const char * | arguments |
Description
Create a new adapter using a single string to represent the command line arguments it will use for initialization.
rallyhere_create_game_instance_adaptern
RH_EXPORT RallyHereStatusCode rallyhere_create_game_instance_adaptern(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments, unsigned int arguments_length)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr * | adapter |
const char * | arguments |
unsigned int | arguments_length |
Description
Create a new adapter using a C-style array to represent the command line arguments it will use for initialization.
rallyhere_create_game_instance_adapter_with_logger
RH_EXPORT RallyHereStatusCode rallyhere_create_game_instance_adapter_with_logger(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments, RallyHereLogCallback callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr * | adapter |
const char * | arguments |
RallyHereLogCallback | callback |
void * | user_data |
Description
Create a new adapter using a single string to represent the command line arguments it will use for initialization and a custom logging function to be used from the moment it is created.
See also
rallyhere_create_game_instance_adaptern_with_logger
RH_EXPORT RallyHereStatusCode rallyhere_create_game_instance_adaptern_with_logger(RallyHereGameInstanceAdapterPtr * adapter, const char * arguments, unsigned int arguments_length, RallyHereLogCallback callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr * | adapter |
const char * | arguments |
unsigned int | arguments_length |
RallyHereLogCallback | callback |
void * | user_data |
Description
Create a new adapter using a C-style array to represent the command line arguments it will use for initialization and a custom logging function to be used from the moment it is created.
See also
rallyhere_destroy_game_instance_adapter
RH_EXPORT void rallyhere_destroy_game_instance_adapter(RallyHereGameInstanceAdapterPtr adapter)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
Description
Destroys the adapter.
Before any memory is freed every registered callback is called with the status RH_STATUS_CANCELLED so that any memory associated with the callback’s user data can be freed.
Repeated at regular intervals
rallyhere_tick
RH_EXPORT RallyHereStatusCode rallyhere_tick(RallyHereGameInstanceAdapterPtr adapter)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
Description
Tick that’s expected to be called every frame.
This is used to check for any messages from the game host. All deferred message processing and callbacks will be handled during this tick.
Returns
RH_STATUS_OK if this adapter can still be used, otherwise an error code.
rallyhere_healthy
RH_EXPORT RallyHereStatusCode rallyhere_healthy(RallyHereGameInstanceAdapterPtr adapter)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
Description
Mark the adapter as healthy.
This is used to tell the game host that this adapter is still alive and well. Should be called at a regular interval. Every 5 seconds is a good rule of thumb. Currently only used by Agones. SIC relies on an open metrics endpoint created by this SDK. i3D relies on the Arcus socket connection. Multiplay reliies on the A2S socket connection.
State request and callbacks
rallyhere_connect
RH_EXPORT void rallyhere_connect(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Begin the process of connecting to the appropriate game host.
The provided callback will be called when the process completes with the result of the connection attempt.
rallyhere_ready
RH_EXPORT void rallyhere_ready(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Tell the game host that this GameInstance can now be allocated.
The provided callback will be called when the process completes with the result of the game host being told this is ready.
rallyhere_on_allocated_callback
RH_EXPORT void rallyhere_on_allocated_callback(RallyHereGameInstanceAdapterPtr adapter, RallyHereOnAllocatedCallback callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
RallyHereOnAllocatedCallback | callback |
void * | user_data |
Description
Register the callback which will be called when the game host has assigned an allocation to this adapter.
rallyhere_test_fake_allocation_response
RH_EXPORT void rallyhere_test_fake_allocation_response(RallyHereGameInstanceAdapterPtr adapter, const char * fake_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char * | fake_data |
Description
Fake an allocation. This should only be used for testing purposes.
rallyhere_allocate
RH_EXPORT void rallyhere_allocate(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Tell the game host that this GameInstance has been allocated.
When using rallyhere_ready()this is used to tell the Game Host that you have recieved the allocation information and have done the appropriate work. In therallyhere_reserve()case this is telling the Game Host that you are allocated by some other means. The provided callback will be called when the process completes with the result
rallyhere_reserve
RH_EXPORT void rallyhere_reserve(RallyHereGameInstanceAdapterPtr adapter, unsigned int timeout_seconds, void(*)(const RallyHereStatusCode &code, void user_data) reserve_callback, void * reserve_user_data, void()(const RallyHereStatusCode &code, void *user_data) ready_callback, void * ready_user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
unsigned int | timeout_seconds |
void(*)(const RallyHereStatusCode &code, void *user_data) | reserve_callback |
void * | reserve_user_data |
void(*)(const RallyHereStatusCode &code, void *user_data) | ready_callback |
void * | ready_user_data |
Description
Tell the game host to reserve this game instance rather than marking it ready.
This will stop the game host from destroying this game instance based on any ready timeouts. This is to be used when the game instance is manually handling sessions in a way that isn’t expected to be handled by the normal matchmaking route. The provided callback will be called when the process completes with the result
rallyhere_reserve_unconditional
RH_EXPORT void rallyhere_reserve_unconditional(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Tell the game host to reserve this game instance rather than marking it ready.
This will stop the game host from destroying this game instance based on any ready timeouts. This is to be used when the game instance is manually handling sessions in a way that isn’t expected to be handled by the normal matchmaking route. The provided callback will be called when the process completes with the result
Soft stop
There are times when the game hosting system would like your instance to shut down, but it does not need to happen immediately. In these situations a soft-stop will be requested so that your instance can finish any currently running games and then stop gracefully. Currently only used by SIC and i3D.
rallyhere_on_soft_stop_callback
RH_EXPORT void rallyhere_on_soft_stop_callback(RallyHereGameInstanceAdapterPtr adapter, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
The callback to trigger when the game host wants to stop the game instance.
In SIC this is expected to come from the SIGTERM handler. In i3D this is expected to come from the Arcus commands
rallyhere_external_soft_stop_requested
RH_EXPORT void rallyhere_external_soft_stop_requested(RallyHereGameInstanceAdapterPtr adapter)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
Description
Inform the adapter that a soft stop has been requested.
There are situations where soft stop comes from something external to the adapter and the adapter needs to be told. In this case the adapter will also trigger the on soft stop callback. This is not a deferred call, so the registered callback will be called immediately. In SIC the SIGTERM handler can’t always be overridden by this adapter. In those situations the caller is expected to call this function as part of their SIGTERM handling.
Stats labels
This is a map of string to string that can be used to store labels for stats. In SIC mode this will be exported as labels on every single prometheus metric. These must be set before calling rallyhere_ready()orrallyhere_reserve()is called.
rallyhere_get_labels
RH_EXPORT void rallyhere_get_labels(RallyHereGameInstanceAdapterPtr adapter, RallyHereStringMapPtr * map)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
RallyHereStringMapPtr * | map |
Description
Get the current string map for the labels.
Caller is responsible for freeing the string map with rallyhere_string_map_destroy.
rallyhere_set_labels
RH_EXPORT void rallyhere_set_labels(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStringMapPtr map, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const RallyHereStringMapPtr | map |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the current string map for the labels.
The string map will be copied. Provide a callback to be notified when the labels have been set. These must be set before calling rallyhere_ready()orrallyhere_reserve()is called.
Additional info
This is a map of string to string that can be used to store additional information about the game instance. In SIC mode this will be exported as labels on the “instance_info” gauge. These can be set after calls to rallyhere_ready()orrallyhere_reserve().
rallyhere_get_additional_info
RH_EXPORT void rallyhere_get_additional_info(RallyHereGameInstanceAdapterPtr adapter, RallyHereStringMapPtr * map)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
RallyHereStringMapPtr * | map |
Description
Get the current string map for the additional info.
Caller is responsible for freeing the string map with rallyhere_string_map_destroy.
rallyhere_set_additional_info
RH_EXPORT void rallyhere_set_additional_info(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStringMapPtr map, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const RallyHereStringMapPtr | map |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the current string map for the additional info.
The string map will be copied. Provide a callback to be notified when the labels have been set. These can be set after calls to rallyhere_ready()orrallyhere_reserve().
Stats annotations
rallyhere_get_annotations
RH_EXPORT void rallyhere_get_annotations(RallyHereGameInstanceAdapterPtr adapter, RallyHereStringMapPtr * map)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
RallyHereStringMapPtr * | map |
Description
Get the current string map for the annotations.
Caller is responsible for freeing the string map.
rallyhere_set_annotations
RH_EXPORT void rallyhere_set_annotations(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStringMapPtr map, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const RallyHereStringMapPtr | map |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the current string map for the annotations.
The string map will be copied. Provide a callback to be notified when the labels have been set.
Stats core
rallyhere_stats_base
RH_EXPORT RallyHereStatusCode rallyhere_stats_base(RallyHereGameInstanceAdapterPtr adapter, const RallyHereStatsBase * stats, const RallyHereStatsBaseProvided * provided, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const RallyHereStatsBase * | stats |
const RallyHereStatsBaseProvided * | provided |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the base stats for the game instance.
Provide a callback to be notified when the stats have been set These will be exported as labels on the “instance_info” gauge. These will be exported as part of the A2S_INFO query.
Stats gauges
rallyhere_stats_gauge
RH_EXPORT void rallyhere_stats_gauge(RallyHereGameInstanceAdapterPtr adapter, const char * name, double value, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char * | name |
double | value |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the value of a gauge. Provide a callback to be notified when the stats have been set. These stats will be exported with the current labels
rallyhere_stats_gauge_with_labels
RH_EXPORT void rallyhere_stats_gauge_with_labels(RallyHereGameInstanceAdapterPtr adapter, const char * name, double value, const RallyHereStringMapPtr labels, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char * | name |
double | value |
const RallyHereStringMapPtr | labels |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the value of a gauge. Provide a callback to be notified when the stats have been set.
Parameters
labels : The labels to export with the gauge
Stats arbitrary
rallyhere_stats_arbitrary
RH_EXPORT void rallyhere_stats_arbitrary(RallyHereGameInstanceAdapterPtr adapter, const char * name, const char * data, unsigned int data_size, void(*)(const RallyHereStatusCode &code, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char * | name |
const char * | data |
unsigned int | data_size |
void(*)(const RallyHereStatusCode &code, void *user_data) | callback |
void * | user_data |
Description
Set the value of an arbitrary stat. Provide a callback to be notified when the stats have been set.
Parameters
data : The data to export with the stat which is copied by the call
rallyhere_stats_arbitrary_move
RH_EXPORT void rallyhere_stats_arbitrary_move(RallyHereGameInstanceAdapterPtr adapter, const char * name, char * data, unsigned int data_size, void(*)(const RallyHereStatusCode &code, char *data, void *user_data) callback, void * user_data)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char * | name |
char * | data |
unsigned int | data_size |
void(*)(const RallyHereStatusCode &code, char *data, void *user_data) | callback |
void * | user_data |
Description
Set the value of an arbitrary stat. Provide a callback to be notified when the stats have been set.
Parameters
data : The data to export with the stat which must have been allocated with the same alloc as set for the adapter. This function takes ownership of that pointer. If the error code is not RH_OK then the pointer is not taken and the caller is responsible
Push metrics
Used for metrics that are push rather than pull. User of the SDK must choose between statsd or graphite as the target for the push.
attention
This is still a work in progress and the API is provided with the expectation that there will be better handling of automatically pushing those metrics in the future. The metric API is stable and generates the correct output foer statsd and graphite, but there is no internal code to send those values out yet.
rallyhere_metrics_immediate_action
RH_EXPORT RallyHereStatusCode rallyhere_metrics_immediate_action(RallyHereGameInstanceAdapterPtr adapter, const RallyHereMetricDefinition * definition, const RallyHereMetricAction * action, RallyHereMetricFlush flush)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const RallyHereMetricDefinition * | definition |
const RallyHereMetricAction * | action |
RallyHereMetricFlush | flush |
Description
rallyhere_metrics_immediate_action_with_time
RH_EXPORT RallyHereStatusCode rallyhere_metrics_immediate_action_with_time(RallyHereGameInstanceAdapterPtr adapter, const RallyHereMetricDefinition * definition, const RallyHereMetricAction * action, double timestamp, RallyHereMetricFlush flush)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const RallyHereMetricDefinition * | definition |
const RallyHereMetricAction * | action |
double | timestamp |
RallyHereMetricFlush | flush |
Description
rallyhere_metrics_statsd_output
RH_EXPORT void rallyhere_metrics_statsd_output(RallyHereGameInstanceAdapterPtr adapter, const char ** data, size_t * data_size)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char ** | data |
size_t * | data_size |
Description
rallyhere_metrics_graphite_output
RH_EXPORT void rallyhere_metrics_graphite_output(RallyHereGameInstanceAdapterPtr adapter, const char ** data, size_t * data_size)
Parameters
Type | Name |
---|---|
RallyHereGameInstanceAdapterPtr | adapter |
const char ** | data |
size_t * | data_size |