File broker_config.h¶

FileList > broker > broker_config.h

#include "config.h"
#include "cas_protocol.h"
#include "environment_variable.h"
#include "porting.h"

Classes¶

Type	Name
struct	t_broker_info

Public Types¶

Type	Name
typedef enum t_access_mode_value	T_ACCESS_MODE_VALUE
typedef struct t_broker_info	T_BROKER_INFO
typedef enum t_connect_order_value	T_CONNECT_ORDER_VALUE
typedef enum t_keep_con_value	T_KEEP_CON_VALUE
typedef enum t_proxy_log_mode_value	T_PROXY_LOG_MODE_VALUE
typedef enum t_slow_log_value	T_SLOW_LOG_VALUE
typedef enum t_sql_log_mode_value	T_SQL_LOG_MODE_VALUE
enum	t_access_mode_value
enum	t_connect_order_value
enum	t_keep_con_value
enum	t_proxy_log_mode_value
enum	t_slow_log_value
enum	t_sql_log_mode_value

Public Functions¶

Type	Name
void	broker_config_dump (FILE * fp, const T_BROKER_INFO * br_info, int num_broker, int br_shm_id, char * admin_log_file)
int	broker_config_read (const char * conf_file, T_BROKER_INFO * br_info, int * num_broker, int * br_shm_id, char * admin_log_file, char admin_flag, bool * acl_flag, char * acl_file, bool * acl_default_policy, char * admin_err_msg)
int	conf_get_value_access_mode (const char * value)
int	conf_get_value_connect_order (const char * value)
int	conf_get_value_keep_con (const char * value)
int	conf_get_value_proxy_log_mode (const char * value)
int	conf_get_value_sql_log_mode (const char * value)
int	conf_get_value_table_allow_deny (const char * value)
int	conf_get_value_table_on_off (const char * value)
void	dir_repath (char * path, size_t path_len)

Macros¶

Type	Name
define	APPL_SERVER_CAS `0`
define	APPL_SERVER_CAS_CGW `1`
define	APPL_SERVER_CAS_CGW_TYPE_NAME `"CAS\_CGW"`
define	APPL_SERVER_CAS_TYPE_NAME `"CAS"`
define	BROKER_INFO_NAME_MAX `([BROKER\_INFO\_PATH\_MAX](broker__config_8h.md#define-broker_info_path_max))`
define	BROKER_INFO_PATH_MAX `([PATH\_MAX](broker__monitor_8c.md#function-timeout))`
define	BROKER_LOG_MSG_SIZE `64`
define	BROKER_NAME_LEN `64 /\* [include](broker__monitor_8c.md#function-timeout) '\0' [character](broker__monitor_8c.md#function-timeout) \*/`
define	BROKER_PATH_MAX `([PATH\_MAX](broker__monitor_8c.md#function-timeout))`
define	CGW_LINK_CONNECT_URL_PROPERTY_LEN `512`
define	CGW_LINK_ODBC_DRIVER_NAME_LEN `256`
define	CGW_LINK_SERVER_IP_LEN `32`
define	CGW_LINK_SERVER_NAME_LEN `256`
define	CGW_LINK_SERVER_PORT_LEN `10`
define	CGW_LINK_STRING_FORMAT_LEN `128`
define	CGW_LINK_URL_MAX_LEN `/* multi line expression */`
define	CLIENT_INFO_SIZE_LIMIT `10000`
define	CONF_ERR_LOG_BOTH `([CONF\_ERR\_LOG\_LOGFILE](broker__config_8h.md#define-conf_err_log_logfile) \\| [CONF\_ERR\_LOG\_BROWSER](broker__config_8h.md#define-conf_err_log_browser))`
define	CONF_ERR_LOG_BROWSER `0x02`
define	CONF_ERR_LOG_LOGFILE `0x01`
define	CONF_ERR_LOG_NONE `0x00`
define	CONF_LOG_FILE_LEN `128`
define	DEFAULE_NET_BUF_SIZE `"16K"`
define	DEFAULT_ACCESS_LOG_MAX_SIZE `"10M"`
define	DEFAULT_AS_MAX_NUM `40`
define	DEFAULT_AS_MIN_NUM `5`
define	DEFAULT_LONG_QUERY_TIME `"1min"`
define	DEFAULT_LONG_TRANSACTION_TIME `"1min"`
define	DEFAULT_MAX_NUM_DELAYED_HOSTS_LOOKUP `-1`
define	DEFAULT_SERVER_HARD_LIMIT `"1G"`
define	DEFAULT_SERVER_MAX_SIZE `"0"`
define	DEFAULT_SHARD_MAX_CLIENTS `256`
define	DEFAULT_SHARD_NUM_PROXY `1`
define	DEFAULT_SHARD_PROXY_LOG_MAX_SIZE `"100M"`
define	DEFAULT_SQL_LOG_MAX_SIZE `"10M"`
define	DEFAULT_SSL_MODE `"OFF"`
define	DEFAULT_TIME_TO_KILL `"2min"`
define	IS_APPL_SERVER_TYPE_CAS (x) `(([x](broker__monitor_8c.md#function-timeout) == [APPL\_SERVER\_CAS](broker__config_8h.md#define-appl_server_cas)) \\|\\| ([x](broker__monitor_8c.md#function-timeout) == [APPL\_SERVER\_CAS\_CGW](broker__config_8h.md#define-appl_server_cas_cgw)))`
define	IS_NOT_APPL_SERVER_TYPE_CAS (x) `![IS\_APPL\_SERVER\_TYPE\_CAS](broker__config_8h.md#define-is_appl_server_type_cas)([x](broker__monitor_8c.md#function-timeout))`
define	MAX_ACCESS_LOG_MAX_SIZE `2097152 /\* 2[G](broker__monitor_8c.md#function-timeout) \*/`
define	MAX_BROKER_NUM `50`
define	MAX_PROXY_LOG_MAX_SIZE `1048576 /\* [about](broker__monitor_8c.md#function-timeout) 1[G](broker__monitor_8c.md#function-timeout) \*/`
define	MAX_SQL_LOG_MAX_SIZE `2097152 /\* 2[G](broker__monitor_8c.md#function-timeout) \*/`
define	SHARD_CONN_STAT_SIZE_LIMIT `256`
define	SHARD_ERR (f, a...)
define	SHARD_INF (f, a...)
define	SHARD_INFO_SIZE_LIMIT `256`
define	SHARD_KEY_STAT_SIZE_LIMIT `2`
define	SQL_LOG_TIME_MAX `-1`

Public Types Documentation¶

typedef T_ACCESS_MODE_VALUE¶

typedef enum t_access_mode_value T_ACCESS_MODE_VALUE;

typedef T_BROKER_INFO¶

typedef struct t_broker_info T_BROKER_INFO;

typedef T_CONNECT_ORDER_VALUE¶

typedef enum t_connect_order_value T_CONNECT_ORDER_VALUE;

typedef T_KEEP_CON_VALUE¶

typedef enum t_keep_con_value T_KEEP_CON_VALUE;

typedef T_PROXY_LOG_MODE_VALUE¶

typedef enum t_proxy_log_mode_value T_PROXY_LOG_MODE_VALUE;

typedef T_SLOW_LOG_VALUE¶

typedef enum t_slow_log_value T_SLOW_LOG_VALUE;

typedef T_SQL_LOG_MODE_VALUE¶

typedef enum t_sql_log_mode_value T_SQL_LOG_MODE_VALUE;

enum t_access_mode_value¶

enum t_access_mode_value {
    READ_WRITE_ACCESS_MODE = 0,
    READ_ONLY_ACCESS_MODE = 1,
    SLAVE_ONLY_ACCESS_MODE = 2
};

enum t_connect_order_value¶

enum t_connect_order_value {
    CONNECT_ORDER_SEQ = 0,
    CONNECT_ORDER_RANDOM = 1,
    CONNECT_ORDER_DEFAULT = CONNECT_ORDER_SEQ
};

enum t_keep_con_value¶

enum t_keep_con_value {
    KEEP_CON_ON = 1,
    KEEP_CON_AUTO = 2,
    KEEP_CON_DEFAULT = KEEP_CON_AUTO
};

enum t_proxy_log_mode_value¶

enum t_proxy_log_mode_value {
    PROXY_LOG_MODE_NONE = 0,
    PROXY_LOG_MODE_ERROR = 1,
    PROXY_LOG_MODE_TIMEOUT = 2,
    PROXY_LOG_MODE_NOTICE = 3,
    PROXY_LOG_MODE_SHARD_DETAIL = 4,
    PROXY_LOG_MODE_SCHEDULE_DETAIL = 5,
    PROXY_LOG_MODE_DEBUG = 6,
    PROXY_LOG_MODE_ALL = 7,
    PROXY_LOG_MODE_DEFAULT = SQL_LOG_MODE_ERROR
};

enum t_slow_log_value¶

enum t_slow_log_value {
    SLOW_LOG_MODE_OFF = 0,
    SLOW_LOG_MODE_ON = 1,
    SLOW_LOG_MODE_DEFAULT = SLOW_LOG_MODE_ON
};

enum t_sql_log_mode_value¶

enum t_sql_log_mode_value {
    SQL_LOG_MODE_NONE = 0,
    SQL_LOG_MODE_ERROR = 1,
    SQL_LOG_MODE_TIMEOUT = 2,
    SQL_LOG_MODE_NOTICE = 3,
    SQL_LOG_MODE_ALL = 4,
    SQL_LOG_MODE_DEFAULT = SQL_LOG_MODE_ERROR
};

Public Functions Documentation¶

function broker_config_dump¶

void broker_config_dump (
    FILE * fp,
    const  T_BROKER_INFO * br_info,
    int num_broker,
    int br_shm_id,
    char * admin_log_file
)

function broker_config_read¶

int broker_config_read (
    const  char * conf_file,
    T_BROKER_INFO * br_info,
    int * num_broker,
    int * br_shm_id,
    char * admin_log_file,
    char admin_flag,
    bool * acl_flag,
    char * acl_file,
    bool * acl_default_policy,
    char * admin_err_msg
)

function conf_get_value_access_mode¶

int conf_get_value_access_mode (
    const  char * value
)

function conf_get_value_connect_order¶

int conf_get_value_connect_order (
    const  char * value
)

function conf_get_value_keep_con¶

int conf_get_value_keep_con (
    const  char * value
)

function conf_get_value_proxy_log_mode¶

int conf_get_value_proxy_log_mode (
    const  char * value
)

function conf_get_value_sql_log_mode¶

int conf_get_value_sql_log_mode (
    const  char * value
)

function conf_get_value_table_allow_deny¶

int conf_get_value_table_allow_deny (
    const  char * value
)

function conf_get_value_table_on_off¶

int conf_get_value_table_on_off (
    const  char * value
)

function dir_repath¶

void dir_repath (
    char * path,
    size_t path_len
)

Macro Definition Documentation¶

define APPL_SERVER_CAS¶

#define APPL_SERVER_CAS `0`

define APPL_SERVER_CAS_CGW¶

#define APPL_SERVER_CAS_CGW `1`

define APPL_SERVER_CAS_CGW_TYPE_NAME¶

#define APPL_SERVER_CAS_CGW_TYPE_NAME `"CAS_CGW"`

define APPL_SERVER_CAS_TYPE_NAME¶

#define APPL_SERVER_CAS_TYPE_NAME `"CAS"`

define BROKER_INFO_NAME_MAX¶

#define BROKER_INFO_NAME_MAX `( BROKER_INFO_PATH_MAX )`

define BROKER_INFO_PATH_MAX¶

#define BROKER_INFO_PATH_MAX `( PATH_MAX )`

define BROKER_LOG_MSG_SIZE¶

#define BROKER_LOG_MSG_SIZE `64`

define BROKER_NAME_LEN¶

#define BROKER_NAME_LEN `64 /* include '\0' character */`

define BROKER_PATH_MAX¶

#define BROKER_PATH_MAX `( PATH_MAX )`

define CGW_LINK_CONNECT_URL_PROPERTY_LEN¶

#define CGW_LINK_CONNECT_URL_PROPERTY_LEN `512`

define CGW_LINK_ODBC_DRIVER_NAME_LEN¶

#define CGW_LINK_ODBC_DRIVER_NAME_LEN `256`

define CGW_LINK_SERVER_IP_LEN¶

#define CGW_LINK_SERVER_IP_LEN `32`

define CGW_LINK_SERVER_NAME_LEN¶

#define CGW_LINK_SERVER_NAME_LEN `256`

define CGW_LINK_SERVER_PORT_LEN¶

#define CGW_LINK_SERVER_PORT_LEN `10`

define CGW_LINK_STRING_FORMAT_LEN¶

#define CGW_LINK_STRING_FORMAT_LEN `128`

define CGW_LINK_URL_MAX_LEN¶

#define CGW_LINK_URL_MAX_LEN `/* multi line expression */`

define CLIENT_INFO_SIZE_LIMIT¶

#define CLIENT_INFO_SIZE_LIMIT `10000`

define CONF_ERR_LOG_BOTH¶

#define CONF_ERR_LOG_BOTH `( CONF_ERR_LOG_LOGFILE | CONF_ERR_LOG_BROWSER )`

define CONF_ERR_LOG_BROWSER¶

#define CONF_ERR_LOG_BROWSER `0x02`

define CONF_ERR_LOG_LOGFILE¶

#define CONF_ERR_LOG_LOGFILE `0x01`

define CONF_ERR_LOG_NONE¶

#define CONF_ERR_LOG_NONE `0x00`

define CONF_LOG_FILE_LEN¶

#define CONF_LOG_FILE_LEN `128`

define DEFAULE_NET_BUF_SIZE¶

#define DEFAULE_NET_BUF_SIZE `"16K"`

define DEFAULT_ACCESS_LOG_MAX_SIZE¶

#define DEFAULT_ACCESS_LOG_MAX_SIZE `"10M"`

define DEFAULT_AS_MAX_NUM¶

#define DEFAULT_AS_MAX_NUM `40`

define DEFAULT_AS_MIN_NUM¶

#define DEFAULT_AS_MIN_NUM `5`

define DEFAULT_LONG_QUERY_TIME¶

#define DEFAULT_LONG_QUERY_TIME `"1min"`

define DEFAULT_LONG_TRANSACTION_TIME¶

#define DEFAULT_LONG_TRANSACTION_TIME `"1min"`

define DEFAULT_MAX_NUM_DELAYED_HOSTS_LOOKUP¶

#define DEFAULT_MAX_NUM_DELAYED_HOSTS_LOOKUP `-1`

define DEFAULT_SERVER_HARD_LIMIT¶

#define DEFAULT_SERVER_HARD_LIMIT `"1G"`

define DEFAULT_SERVER_MAX_SIZE¶

#define DEFAULT_SERVER_MAX_SIZE `"0"`

define DEFAULT_SHARD_MAX_CLIENTS¶

#define DEFAULT_SHARD_MAX_CLIENTS `256`

define DEFAULT_SHARD_NUM_PROXY¶

#define DEFAULT_SHARD_NUM_PROXY `1`

define DEFAULT_SHARD_PROXY_LOG_MAX_SIZE¶

#define DEFAULT_SHARD_PROXY_LOG_MAX_SIZE `"100M"`

define DEFAULT_SQL_LOG_MAX_SIZE¶

#define DEFAULT_SQL_LOG_MAX_SIZE `"10M"`

define DEFAULT_SSL_MODE¶

#define DEFAULT_SSL_MODE `"OFF"`

define DEFAULT_TIME_TO_KILL¶

#define DEFAULT_TIME_TO_KILL `"2min"`

define IS_APPL_SERVER_TYPE_CAS¶

#define IS_APPL_SERVER_TYPE_CAS (
    x
) `(( x == APPL_SERVER_CAS ) || ( x == APPL_SERVER_CAS_CGW ))`

define IS_NOT_APPL_SERVER_TYPE_CAS¶

#define IS_NOT_APPL_SERVER_TYPE_CAS (
    x
) `! IS_APPL_SERVER_TYPE_CAS ( x )`

define MAX_ACCESS_LOG_MAX_SIZE¶

#define MAX_ACCESS_LOG_MAX_SIZE `2097152    /* 2 G */`

define MAX_BROKER_NUM¶

#define MAX_BROKER_NUM `50`

define MAX_PROXY_LOG_MAX_SIZE¶

#define MAX_PROXY_LOG_MAX_SIZE `1048576 /* about 1 G */`

define MAX_SQL_LOG_MAX_SIZE¶

#define MAX_SQL_LOG_MAX_SIZE `2097152   /* 2 G */`

define SHARD_CONN_STAT_SIZE_LIMIT¶

#define SHARD_CONN_STAT_SIZE_LIMIT `256`

define SHARD_ERR¶

#define SHARD_ERR (
    f,
    a...
)

define SHARD_INF¶

#define SHARD_INF (
    f,
    a...
)

define SHARD_INFO_SIZE_LIMIT¶

#define SHARD_INFO_SIZE_LIMIT `256`

define SHARD_KEY_STAT_SIZE_LIMIT¶

#define SHARD_KEY_STAT_SIZE_LIMIT `2`

define SQL_LOG_TIME_MAX¶

#define SQL_LOG_TIME_MAX `-1`

The documentation for this class was generated from the following file cubrid/src/broker/broker_config.h