monero_c_rpc_connection.h

Go to the documentation of this file.

 
#ifndef MONERO_C_RPC_CONNECTION_H
#define MONERO_C_RPC_CONNECTION_H
 
#include "utils/monero_c_utils.h"
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// ----------------------------- RPC CONNECTION -------------------------------
// each function wraps the monero_rpc_connection method of the same name. A JSON argument can't
// nest deeper than 64 levels. On error, string and buffer outputs are set to NULL and scalar
// outputs are left unchanged
 
typedef struct monero_rpc_connection monero_rpc_connection;
 
typedef enum monero_optional_bool {
  MONERO_OPTIONAL_BOOL_UNSET = -1,
  MONERO_OPTIONAL_BOOL_FALSE = 0,
  MONERO_OPTIONAL_BOOL_TRUE = 1
} monero_optional_bool;
 
MONERO_EXPORT monero_result monero_rpc_connection_create(const char* connection_json, monero_rpc_connection** out_connection);
 
MONERO_EXPORT void monero_rpc_connection_free(monero_rpc_connection* connection);
 
MONERO_EXPORT monero_result monero_rpc_connection_serialize(monero_rpc_connection* connection, char** out_json);
 
MONERO_EXPORT monero_result monero_rpc_connection_set_credentials(monero_rpc_connection* connection, const char* username, const char* password);
 
MONERO_EXPORT monero_result monero_rpc_connection_set_attribute(monero_rpc_connection* connection, const char* key, const char* value);
 
MONERO_EXPORT monero_result monero_rpc_connection_get_attribute(monero_rpc_connection* connection, const char* key, char** out_value);
 
MONERO_EXPORT monero_result monero_rpc_connection_is_onion(monero_rpc_connection* connection, bool* out_is_onion);
 
MONERO_EXPORT monero_result monero_rpc_connection_is_i2p(monero_rpc_connection* connection, bool* out_is_i2p);
 
MONERO_EXPORT monero_result monero_rpc_connection_is_online(monero_rpc_connection* connection, monero_optional_bool* out_is_online);
 
MONERO_EXPORT monero_result monero_rpc_connection_is_authenticated(monero_rpc_connection* connection, monero_optional_bool* out_is_authenticated);
 
MONERO_EXPORT monero_result monero_rpc_connection_is_connected(monero_rpc_connection* connection, monero_optional_bool* out_is_connected);
 
MONERO_EXPORT monero_result monero_rpc_connection_check_connection(monero_rpc_connection* connection, const uint32_t* timeout_ms, bool* out_changed);
 
MONERO_EXPORT monero_result monero_rpc_connection_send_json_request(monero_rpc_connection* connection, const char* method, const char* params_json, const uint32_t* timeout_ms, char** out_json);
 
MONERO_EXPORT monero_result monero_rpc_connection_send_path_request(monero_rpc_connection* connection, const char* path, const char* params_json, const uint32_t* timeout_ms, char** out_json);
 
MONERO_EXPORT monero_result monero_rpc_connection_send_binary_request(monero_rpc_connection* connection, const char* path, const char* params_json, const uint32_t* timeout_ms, uint8_t** out_data, size_t* out_len);
 
#ifdef __cplusplus
}
#endif
 
#endif // MONERO_C_RPC_CONNECTION_H