Epoch/Server_Install_Pack/@epochhive/README.md

A3 Epoch Hive Calls

Full A3 epoch server hive call documentation

000

Get and return Instance ID from config

Input: None

Returns: ARRAY format: ["NA123"]

"epochserver" callExtension "000";

001

STEAMAPI - Vac ban check

Input: SteamID64

Returns: Nothing

"epochserver" callExtension format["001|%1", _uid];

100

Setter - Temporarily stack, workaround for Arma 8k character limitation. Used in combination with the SET or SETEX calls.

Uses:  SET

Call Type: Synchronous

Input: Key, Call Index ID, Value

Returns: Nothing

"epochserver" callExtension format["100|%1:%2|%3|%4", 100, _prefix, _key, _hiveCallID, _value];

101 

Setter - Temporarily stack, workaround for Arma 8k character limitation. Used in combination with the SET or SETEX calls.

Uses:  SET

Call Type: Asynchronous

Input: Key, Call Index ID, Value

Returns: Nothing

"epochserver" callExtension format["100|%1:%2|%3|%4", 101, _prefix, _key, _hiveCallID, _value];

110 

Store value in database with the specified key

Uses:  SET

Call Type: Synchronous

Input: Key, Call Index ID, Value

Returns: Nothing

"epochserver" callExtension format["110|%1:%2|%3|%4", _prefix, _key, _hiveCallID, _value];

111

Store value in database with the specified key

Uses:  SET

Call Type: Asynchronous

Input: Key, Call Index ID, Value

Returns: Nothing

"epochserver" callExtension format["111|%1:%2|%3|%4", _prefix, _key, _hiveCallID, _value];

120

Uses:  SETEX

Call Type: Asynchronous

Input: Key, Expires, Call Index ID, Value

Returns: Nothing

"epochserver" callExtension format["120|%1:%2|%3|%4|%5", _prefix, _key, _expires, _hiveCallID, _value];

121

Store value in database with the specified key and expiration.

Uses:  SETEX

Call Type: Asynchronous

Input: Key, Expires, Call Index ID, Value

Returns: Nothing

"epochserver" callExtension format["121|%1:%2|%3|%4|%5", _prefix, _key, _expires, _hiveCallID, _value];

130

Set a timeout on key. After the timeout has expired, the key will automatically be deleted.

Uses:  EXPIRE

Call Type: Synchronous

Input: Key, Expires

Returns: Nothing

"epochserver" callExtension format ["130|%1:%2|%3", _prefix, _key, _expires];

131

Set a timeout on key. After the timeout has expired, the key will automatically be deleted.

Uses:  EXPIRE

Call Type: Asynchronous

Input: Key, Expires

Returns: Nothing

"epochserver" callExtension format ["130|%1:%2|%3", _prefix, _key, _expires];

140

Sets or clears the bit at offset in the string value stored at key.

Uses: SETBIT

Call Type: Synchronous

Input: Key, Bit Index, Value

Returns: Nothing

"epochserver" callExtension format["140|%1:%2|%3|%4", _prefix, _key, _bitIndex, _value];

141

Sets or clears the bit at offset in the string value stored at key.

Uses: SETBIT

Call Type: Asynchronous

Input: Key, Bit Index, Value

Returns: Nothing

"epochserver" callExtension format["141|%1:%2|%3|%4", _prefix, _key, _bitIndex, _value];

200

Uses: GET

Call Type: Synchronous

Input: Key, Bit Index, Value

_Returns: _Array

_hiveResponse = "epochserver" callExtension format ["200|%1:%2", _prefix, _key];

210

Uses: GET, TLL

Call Type: Synchronous

Input: Key, Bit Index, Value

Returns: Array

_hiveResponse = "epochserver" callExtension format ["210|%1:%2", _prefix, _key];

220

Uses: GETRANGE

Call Type: Synchronous

Input: Key, Start Index, Stop Index

Returns: Array

_hiveResponse = "epochserver" callExtension format["220|%1:%2|%3|%4", _prefix, _key, _currentIndex, (_currentIndexMax-1)];

230

Uses: GETBIT

Call Type: Synchronous

Input: Key, Bit Index, Value (0-1)

Returns: BOOL

_hiveResponse = "epochserver" callExtension format["240|%1:%2|%3", _prefix, _key, _value];

300

Uses: TTL

Call Type: Synchronous

Input: Key

Returns: TTL in seconds

"epochserver" callExtension format["300|%1:%2", _prefix, _uniqueID];

400

Removes the specified key.

Uses: DEL

Call Type: Synchronous

Input: Key

Returns: Nothing

"epochserver" callExtension format["400|%1:%2", _prefix, _uniqueID];

500

Uses: PING

Call Type: Synchronous

Input: Nothing

Returns: "PONG"

'epochserver' callExtension '500'

501

Get current time.

Call Type: Synchronous

Input: Nothing

Returns: Array [YYYY,MM,DD,HH,MM,SS]

'epochserver' callExtension '510'

600

Used to push data from database server in a queue.

Uses: LPOP with CMD- prefix

Call Type: Synchronous

Input: Server InstanceID

Returns: Array [1,""]

_response = "epochserver" callExtension format["600|%1",_instanceID];

700

Log in Redis

_Uses: LPUSH _with -LOG postfix

Call Type: Synchronous

Input: Key Prefix, Message

Returns: Nothing

"epochserver" callExtension format["700|%1|%2", _prefix, _message];

701

Log in Redis

_Uses: LPUSH _with -LOG postfix

Call Type: Synchronous

Input: Key Prefix, Message

Returns: Nothing

"epochserver" callExtension format["701|%1|%2", _prefix, _message];

800

Append strings specified to end of first line of publicvariable.txt and then runs BE command #loadEvents.

Call Type: Synchronous

Input: Strings

Returns: Nothing

"epochserver" callExtension format["800|%1|%2|%3|%4", _var1, _var2, _var3, _var4];

801

Append strings specified to end of first line of publicvariable.txt and then runs BE command #loadEvents.

Call Type: Asynchronous

Input: Strings

Returns: Nothing

"epochserver" callExtension format["800|%1|%2|%3|%4", _var1, _var2, _var3, _var4];

810

Get random string, [a-zA-Z]{5-10}, if only one string is requested it will return a string instead of a array

Call Type: Synchronous

Input: Count

Returns: Array or String

_response = 'epochserver' callExtension format['810|%1',_count];

820

Add ban to bans.txt and execute #loadBans (Depreciated should use 900 calls)

Call Type: Synchronous

Input: Steam64ID, Reason

Returns: Nothing

'epochserver' callExtension format['820|%1|%2',getPlayerUID _playerObj,_reason];

821

Add ban to bans.txt and execute #loadBans (Depreciated should use 900 calls)

Call Type: Synchronous

Input: Steam64ID, Reason

Returns: Nothing

epochserver' callExtension format['821|%1|%2',getPlayerUID _playerObj,_reason];

901

Broadcast message to server

Call Type: Asynchronous

Input: Message

Returns: Nothing

'epochserver' callExtension format['901|%1', _message];

911

Kick with message

Call Type: Asynchronous

Input: player64ID, Message

Returns: Nothing

'epochserver' callExtension format['911|%1|%2', _playerUID, _reason];

921

Ban with message and duration

Call Type: Asynchronous

Input: player64ID, Message, duration

Returns: Nothing

'epochserver' callExtension format['921|%1|%2|%3', _playerUID, _message, _duration];

930

Unlock server using BE command #unlock

Call Type: Asynchronous

Input: Nothing

Returns: Nothing

'epochserver' callExtension '930'

931

Lock server using BE command #lock

Call Type: Asynchronous

Input: Nothing

Returns: Nothing

'epochserver' callExtension '931'

991

Shutdown Server using BE #shutdown command.  

Call Type: Asynchronous

Input: Nothing

Returns: Nothing

'epochserver' callExtension '991'