table_dataset: Helps you implement a table with automatted storage.(3)

NAME
table_dataset: Helps you implement a table with automatted storage. - This handler helps you implement a table where all the data is expected to be stored within the agent itself and not in some external storage location. More...

  Functions
netsnmp_table_data_set * netsnmp_create_table_data_set (const char *table_name)
Create a netsnmp_table_data_set structure given a table_data definition.
netsnmp_mib_handler * netsnmp_get_table_data_set_handler (netsnmp_table_data_set *data_set)
Given a netsnmp_table_data_set definition, create a handler for it.
int netsnmp_register_table_data_set (netsnmp_handler_registration *reginfo, netsnmp_table_data_set *data_set, netsnmp_table_registration_info *table_info)
register a given data_set at a given oid (specified in the netsnmp_handler_registration pointer).
netsnmp_table_data_set_storage * netsnmp_table_data_set_find_column (netsnmp_table_data_set_storage *start, unsigned int column)
Finds a column within a given storage set, given the pointer to the start of the storage set list.
netsnmp_table_data_set * netsnmp_extract_table_data_set (netsnmp_request_info *request)
extracts a netsnmp_table_data_set pointer from a given request.
int netsnmp_mark_row_column_writable (netsnmp_table_row *row, int column, int writable)
marks a given column in a row as writable or not.
int netsnmp_set_row_column (netsnmp_table_row *row, unsigned int column, int type, const char *value, size_t value_len)
sets a given column in a row with data given a type, value, and length.
int netsnmp_table_set_add_default_row (netsnmp_table_data_set *table_set, unsigned int column, int type, int writable, void *default_value, size_t default_value_len)
adds a new default row to a table_set.
netsnmp_table_row * netsnmp_table_data_set_clone_row (netsnmp_table_row *row)
clones a dataset row, including all data.
netsnmp_table_row * netsnmp_table_data_set_create_row_from_defaults (netsnmp_table_data_set_storage *defrow)
creates a new row from an existing defined default set.
int netsnmp_table_data_set_helper_handler (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)
implements the table data helper.
void netsnmp_register_auto_data_table (netsnmp_table_data_set *table_set, char *registration_name)
registers a table_dataset so that the 'add_row' snmpd.conf token can be used to add data to this table.
void netsnmp_config_parse_table_set (const char *token, char *line)
void netsnmp_config_parse_add_row (const char *token, char *line)
void netsnmp_table_dataset_add_index (netsnmp_table_data_set *table, u_char type)
adds an index to the table.
void netsnmp_table_dataset_add_row (netsnmp_table_data_set *table, netsnmp_table_row *row)
adds a new row to a dataset table.
void netsnmp_table_dataset_replace_row (netsnmp_table_data_set *table, netsnmp_table_row *origrow, netsnmp_table_row *newrow)
adds a new row to a dataset table.
netsnmp_table_data_set_storage * netsnmp_table_dataset_delete_data (netsnmp_table_data_set_storage *data)
deletes a single dataset table data.
void netsnmp_table_dataset_delete_all_data (netsnmp_table_data_set_storage *data)
deletes all the data from this node and beyond in the linked list.
void netsnmp_table_dataset_delete_row (netsnmp_table_row *row)
deletes all the data from this node and beyond in the linked list.
void netsnmp_table_dataset_remove_row (netsnmp_table_data_set *table, netsnmp_table_row *row)
removes a row from the table, but doesn't delete/free anything.
void netsnmp_table_dataset_remove_and_delete_row (netsnmp_table_data_set *table, netsnmp_table_row *row)
removes a row from the table and then deletes it (and all it's data).
void netsnmp_table_set_multi_add_default_row (va_dcl) va_dcl
adds multiple data column definitions to each row.

DETAILED DESCRIPTION

This handler helps you implement a table where all the data is expected to be stored within the agent itself and not in some external storage location.

It handles all MIB requests including GETs, GETNEXTs and SETs. It's possible to simply create a table without actually ever defining a handler to be called when SNMP requests come in. To use the data, you can either attach a sub-handler that merely uses/manipulates the data further when requests come in, or you can loop through it externally when it's actually needed. This handler is most useful in cases where a table is holding configuration data for something which gets triggered via another event.

NOTE NOTE NOTE: This helper isn't complete and is likely to change somewhat over time. Specifically, the way it stores data internally may change drastically.

FUNCTION DOCUMENTATION

  void netsnmp_config_parse_add_row (const char * token, char * line)

For internal use only.

Definition at line 707 of file table_dataset.c.

  void netsnmp_config_parse_table_set (const char * token, char * line)

For internal use only.

Definition at line 613 of file table_dataset.c.

  netsnmp_table_data_set* netsnmp_create_table_data_set (const char * table_name)

Create a netsnmp_table_data_set structure given a table_data definition.

Examples:
data_set.c.

Definition at line 63 of file table_dataset.c.

Referenced by netsnmp_config_parse_table_set().

  netsnmp_table_data_set* netsnmp_extract_table_data_set (netsnmp_request_info * request) [inline]

extracts a netsnmp_table_data_set pointer from a given request.

Definition at line 144 of file table_dataset.c.

  netsnmp_mib_handler* netsnmp_get_table_data_set_handler (netsnmp_table_data_set * data_set)

Given a netsnmp_table_data_set definition, create a handler for it.

Definition at line 72 of file table_dataset.c.

Referenced by netsnmp_register_table_data_set().

  int netsnmp_mark_row_column_writable (netsnmp_table_row * row, int column, int writable)

marks a given column in a row as writable or not.

Examples:
data_set.c.

Definition at line 154 of file table_dataset.c.

Referenced by netsnmp_config_parse_add_row(), and netsnmp_table_data_set_create_row_from_defaults().

  void netsnmp_register_auto_data_table (netsnmp_table_data_set * table_set, char * registration_name)

registers a table_dataset so that the 'add_row' snmpd.conf token can be used to add data to this table.

If registration_name is NULL then the name used when the table was created will be used instead.

Todo:
 create a properly free'ing registeration pointer for the datalist, and get the datalist freed at shutdown.

Examples:
data_set.c.

Definition at line 598 of file table_dataset.c.

Referenced by netsnmp_config_parse_table_set().

  int netsnmp_register_table_data_set (netsnmp_handler_registration * reginfo, netsnmp_table_data_set * data_set, netsnmp_table_registration_info * table_info)

register a given data_set at a given oid (specified in the netsnmp_handler_registration pointer).

The reginfo->handler->access_method *may* be null if the call doesn't ever want to be called for SNMP operations.

Examples:
data_set.c.

Definition at line 95 of file table_dataset.c.

Referenced by netsnmp_config_parse_table_set().

  int netsnmp_set_row_column (netsnmp_table_row * row, unsigned int column, int type, const char * value, size_t value_len)

sets a given column in a row with data given a type, value, and length.

Data is memdup'ed by the function.

Examples:
data_set.c.

Definition at line 182 of file table_dataset.c.

Referenced by netsnmp_config_parse_add_row(), and netsnmp_table_data_set_create_row_from_defaults().

  netsnmp_table_row* netsnmp_table_data_set_clone_row (netsnmp_table_row * row)

clones a dataset row, including all data.

Definition at line 270 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  netsnmp_table_row* netsnmp_table_data_set_create_row_from_defaults (netsnmp_table_data_set_storage * defrow)

creates a new row from an existing defined default set.

Definition at line 305 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  netsnmp_table_data_set_storage* netsnmp_table_data_set_find_column (netsnmp_table_data_set_storage * start, unsigned int column)

Finds a column within a given storage set, given the pointer to the start of the storage set list.

Definition at line 133 of file table_dataset.c.

Referenced by netsnmp_mark_row_column_writable(), netsnmp_set_row_column(), netsnmp_table_data_set_helper_handler(), and netsnmp_table_set_add_default_row().

  int netsnmp_table_data_set_helper_handler (netsnmp_mib_handler * handler, netsnmp_handler_registration * reginfo, netsnmp_agent_request_info * reqinfo, netsnmp_request_info * requests)

implements the table data helper.

This is the routine that takes care of all SNMP requests coming into the table.

Definition at line 324 of file table_dataset.c.

  void netsnmp_table_dataset_add_index (netsnmp_table_data_set * table, u_char type) [inline]

adds an index to the table.

Call this repeatly for each index.

Examples:
data_set.c.

Definition at line 761 of file table_dataset.c.

Referenced by netsnmp_config_parse_table_set().

  void netsnmp_table_dataset_add_row (netsnmp_table_data_set * table, netsnmp_table_row * row) [inline]

adds a new row to a dataset table.

Examples:
data_set.c.

Definition at line 768 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  void netsnmp_table_dataset_delete_all_data (netsnmp_table_data_set_storage * data) [inline]

deletes all the data from this node and beyond in the linked list.

Definition at line 800 of file table_dataset.c.

Referenced by netsnmp_table_dataset_delete_row(), and netsnmp_table_dataset_remove_and_delete_row().

  netsnmp_table_data_set_storage* netsnmp_table_dataset_delete_data (netsnmp_table_data_set_storage * data) [inline]

deletes a single dataset table data.

returns the (possibly still good) next pointer of the deleted data object.

Definition at line 787 of file table_dataset.c.

Referenced by netsnmp_table_dataset_delete_all_data().

  void netsnmp_table_dataset_delete_row (netsnmp_table_row * row) [inline]

deletes all the data from this node and beyond in the linked list.

Definition at line 810 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  void netsnmp_table_dataset_remove_and_delete_row (netsnmp_table_data_set * table, netsnmp_table_row * row) [inline]

removes a row from the table and then deletes it (and all it's data).

Definition at line 832 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  void netsnmp_table_dataset_remove_row (netsnmp_table_data_set * table, netsnmp_table_row * row) [inline]

removes a row from the table, but doesn't delete/free anything.

Definition at line 823 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  void netsnmp_table_dataset_replace_row (netsnmp_table_data_set * table, netsnmp_table_row * origrow, netsnmp_table_row * newrow) [inline]

adds a new row to a dataset table.

Definition at line 776 of file table_dataset.c.

Referenced by netsnmp_table_data_set_helper_handler().

  int netsnmp_table_set_add_default_row (netsnmp_table_data_set * table_set, unsigned int column, int type, int writable, void * default_value, size_t default_value_len)

adds a new default row to a table_set.

Arguments should be the table_set, column number, variable type and finally a 1 if it is allowed to be writable, or a 0 if not. If the default_value field is not NULL, it will be used to populate new valuse in that column fro newly created rows. It is copied into the storage template (free your calling argument).

returns SNMPERR_SUCCESS or SNMPERR_FAILURE

Definition at line 231 of file table_dataset.c.

Referenced by netsnmp_config_parse_table_set().

  void netsnmp_table_set_multi_add_default_row (va_dcl)

adds multiple data column definitions to each row.

Functionally, this is a wrapper around calling netsnmp_table_set_add_default_row repeatedly for you.

Examples:
data_set.c.

Definition at line 851 of file table_dataset.c.