Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / ucd-snmp / draft / man3 / default_store.3

.\" 
.\" Japanese Version Copyright (c) 2001 Yuichi SATO
.\"         all rights reserved.
.\" Translated Mon Aug 20 07:04:42 JST 2001
.\"         by Yuichi SATO <ysato@h4.dion.ne.jp>
.\"
.TH SNMP_AGENT_API 3 "27 Oct 1999"
.UC 5
.\"O .SH NAME
.SH ̾Á°
.\"O default_store \- generic storage of global data.
default_store \- Âç°è¥Ç¡¼¥¿¤Î°ìÈÌŪ¤Ê³ÊǼ¾ì½ê
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
#include <ucd-snmp/ucd-snmp-config.h>
#include <ucd-snmp/ucd-snmp-includes.h>

int ds_set_boolean(int storeid, int which, int value);
int ds_get_boolean(int storeid, int which);
int ds_set_int(int storeid, int which, int value);
int ds_get_int(int storeid, int which);
int ds_set_string(int storeid, int which, const char *value);
char *ds_get_string(int storeid, int which);
int ds_register_config(u_char type, const char *ftype, const char *token,
                       int storeid, int which);
int ds_register_premib(u_char type, const char *ftype, const char *token,
                       int storeid, int which);
void ds_shutdown(void);
.fi
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The purpose of the default storage is three-fold:
¥Ç¥Õ¥©¥ë¥È¤Î¥Ç¡¼¥¿³ÊǼ¾ì½ê¤ÎÌÜŪ¤Ï¡¢¼¡¤Î 3 ¤Ä¤Ç¤¢¤ë:
.IP 1)
.\"O To create a global storage space without creating a whole bunch of
.\"O globally accessible variables or a whole bunch of access functions to
.\"O work with more privately restricted variables.
Âç°èŪ¤Ë¥¢¥¯¥»¥¹¤Ç¤­¤ëÊÑ¿ô¤ä
¤â¤Ã¤È¸ø³«¤ÎÀ©¸Â¤µ¤ì¤¿ÊÑ¿ô¤Ë¥¢¥¯¥»¥¹¤¹¤ë´Ø¿ô·²¤òºîÀ®¤·¤¿¤ê¤»¤º¤Ë¡¢
Âç°èŪ¤Ê¥Ç¡¼¥¿³ÊǼ¾ì½ê¤òºîÀ®¤¹¤ë¡£
.IP 2)
.\"O To provide a single location where the thread locking needs to be
.\"O implemented. At the time of this writing, however, thread locking is not
.\"O yet in place.
¥¹¥ì¥Ã¥É (thread) ¥í¥Ã¥¯¤ò¼ÂÁõ¤¹¤ëɬÍפ¬¤¢¤ë³ÊǼ¾ì½ê¤òÄ󶡤¹¤ë¡£
¤·¤«¤·¡¢¤³¤ì¤ò½ñ¤¤¤Æ¤¤¤ë»þÅÀ¤Ç¤Ï¡¢¥¹¥ì¥Ã¥É¥í¥Ã¥¯¤Ï¤Þ¤À¼ÂÁõ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.IP 3)
.\"O To reduce the number of cross dependencies between code pieces that
.\"O may or may not be linked together in the long run. This provides for a
.\"O single location in which configuration data, for example, can be
.\"O stored for a separate section of code that may not be linked in to
.\"O the application in question.
¥³¡¼¥É´Ö¤ÎÁê¸ß°Í¸À­¤Î¿ô¤ò¸º¤é¤¹
(¥³¡¼¥É¤ÏºÇ½ªÅª¤Ë¥ê¥ó¥¯¤·¤Æ¤â¤·¤Ê¤¯¤Æ¤âÎɤ¤)¡£
ÌäÂê¤È¤·¤Æ¤¤¤ë¥¢¥×¥ê¥±¡¼¥·¥ç¥óÆâ¤Ç¥ê¥ó¥¯¤µ¤ì¤Ê¤¤¡¢
ÊÌ¡¹¤Î¥»¥¯¥·¥ç¥ó¤Î¥³¡¼¥É¤Ç»È¤ï¤ì¤ëÀßÄê¥Ç¡¼¥¿¤Î¤è¤¦¤Ê
¥Ç¡¼¥¿¤Î³ÊǼ¾ì½ê¤òÄ󶡤¹¤ë¡£
.PP
.\"O The functions defined here implement these goals.
¤³¤³¤ÇÄêµÁ¤µ¤ì¤ë´Ø¿ô¤Ï¡¢°Ê²¼¤ÎÌÜŪ¤ò (¼Â¸½¤¹¤ëµ¡Ç½¤ò) ¼ÂÁõ¤·¤Æ¤¤¤ë¡£
.PP
.\"O Currently, three data types are supported: boolean's, integers, and
.\"O strings. Each of based trade data types have separate storage
.\"O spaces. In addition, the storage space for each data type is divided
.\"O further by the application level.   Currently, there are two storage
.\"O spaces. The first is reserved for the SNMP library itself. The second 
.\"O is intended for use in applications and is not modified or checked by
.\"O the library, and, therefore, this is the space usable by you.
¸½ºß¤Î¤È¤³¤í¿¿µ¶ÃÍ (boolean)¡¦À°¿ôÃÍ (integer)¡¦
ʸ»úÎó (string) ¤È¤¤¤¦ 3 ¤Ä¤Î¥Ç¡¼¥¿·¿¤¬¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤ë¡£
³Æ¥Ç¡¼¥¿·¿¤Î¥Ç¡¼¥¿¤Ï¡¢ÊÌ¡¹¤Î³ÊǼ¾ì½ê¤Ëʬ¤±¤é¤ì¤Æ¤¤¤ë¡£
¤µ¤é¤Ë¡¢³Æ¥Ç¡¼¥¿·¿¤Î³ÊǼ¾ì½ê¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥ì¥Ù¥ë¤Ç¤âʬ³ä¤µ¤ì¤Æ¤¤¤ë¡£
¸½ºß¤Î¤È¤³¤í 2 ¤Ä¤Î³ÊǼ¾ì½ê¤¬¤¢¤ë¡£
1 ¤ÄÌܤγÊǼ¾ì½ê¤Ï¡¢SNMP ¥é¥¤¥Ö¥é¥ê¼«¿È¤Ë¤è¤Ã¤ÆͽÌ󤵤ì¤Æ¤¤¤ë¡£
2 ¤ÄÌܤγÊǼ¾ì½ê¤Ï¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ë¤è¤Ã¤Æ»È¤ï¤ì¤ë¤³¤È¤ò°Õ¿Þ¤·¤Æ¤ª¤ê¡¢
¥é¥¤¥Ö¥é¥ê¤Ë¤è¤ëÊѹ¹¤ä¥Á¥§¥Ã¥¯¤¬¹Ô¤ï¤ì¤Ê¤¤¤Î¤Ç¡¢
¥æ¡¼¥¶¡¼¤¬»È¤¤¤ä¤¹¤¤¤â¤Î¤Ë¤Ê¤Ã¤Æ¤¤¤ë¡£
.PP
.\"O You can think of these storage spaces as being 3 arrays, something
.\"O like bool_storage[storeid][which], int_storage[storeid][which], and
.\"O string_storage[storeid][which].  The data is then accessed through the 
.\"O functions defined below.  For data you wish to store, you should use a 
.\"O storeid of DS_APPLICATION_ID.
3 ¤Ä¤Î³ÊǼ¾ì½ê¤Ï¡¢
bool_storage[storeid][which], int_storage[storeid][which], 
string_storage[storeid][which] 
¤È¤¤¤¦ 3 ¤Ä¤ÎÇÛÎó¤È¹Í¤¨¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
¥Ç¡¼¥¿¤Ï°Ê²¼¤ÇÄêµÁ¤µ¤ì¤ë´Ø¿ô¤Ç¥¢¥¯¥»¥¹¤Ç¤­¤ë¡£
³ÊǼ¤·¤¿¤¤¥Ç¡¼¥¿¤¬¤¢¤ë¾ì¹ç¤Ï¡¢
DS_APPLICATION_ID ¤È¤¤¤¦ storeid ¤ò»È¤¨¤ÐÎɤ¤¡£
.PP
.\"O The storage space used by the library is defined in the
.\"O default_store.h file, which currently contains the following defines:
¥é¥¤¥Ö¥é¥ê¤¬»È¤¦³ÊǼ¾ì½ê¤Ï¡¢default_store.h ¤ÇÄêµÁ¤µ¤ì¤Æ¤ª¤ê¡¢
¸½ºß¤Î¤È¤³¤í°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë¡£
.PP
.nf
.\"O /* These definitions correspond with the "storid" argument to the API */
/* °Ê²¼¤ÎÄêµÁ¤Ï API ¤Î "storeid" °ú¤­¿ô¤È¤·¤Æ»È¤ï¤ì¤ë¡£ */
#define DS_LIBRARY_ID     0
#define DS_APPLICATION_ID 1
#define DS_TOKEN_ID       2

.\"O /* These definitions correspond with the "which" argument to the API,
.\"O    when the storeid argument is DS_LIBRARY_ID */
/* storeid ¤¬ DS_LIBRARY_ID ¤Î¾ì¹ç¡¢
   °Ê²¼¤ÎÄêµÁ¤Ï API ¤Î "which" °ú¤­¿ô¤È¤·¤Æ»È¤ï¤ì¤ë¡£*/
.\"O /* library booleans */
/* ¿¿µ¶ÃͤòÁàºî¤¹¤ë¥é¥¤¥Ö¥é¥ê¤Ç»È¤ï¤ì¤ë¤â¤Î */
#define DS_LIB_MIB_ERRORS          0
#define DS_LIB_SAVE_MIB_DESCRS     1
#define DS_LIB_MIB_COMMENT_TERM    2
#define DS_LIB_MIB_PARSE_LABEL     3
#define DS_LIB_DUMP_PACKET         4
#define DS_LIB_LOG_TIMESTAMP       5
#define DS_LIB_DONT_READ_CONFIGS   6
.\"O #define DS_LIB_MIB_REPLACE         7  /* replace objects from latest module */
#define DS_LIB_MIB_REPLACE         7  /* ¥ª¥Ö¥¸¥§¥¯¥È¤òºÇ¿·¤Î¥â¥¸¥å¡¼¥ë¤ÇÃÖ¤­´¹¤¨¤ë */
.\"O #define DS_LIB_PRINT_NUMERIC_ENUM  8  /* print only numeric enum values */
#define DS_LIB_PRINT_NUMERIC_ENUM  8  /* ¿ôÃͤÎÎóµó·¿ (enum) ÃͤΤߤòɽ¼¨¤¹¤ë */
.\"O #define DS_LIB_PRINT_NUMERIC_OIDS  9  /* print only numeric enum values */
#define DS_LIB_PRINT_NUMERIC_OIDS  9  /* ¿ôÃͤΠoid ¤Î¤ß¤òɽ¼¨¤¹¤ë */
.\"O #define DS_LIB_DONT_BREAKDOWN_OIDS 10 /* dont print oid indexes specially */
#define DS_LIB_DONT_BREAKDOWN_OIDS 10 /* oid ¥¤¥ó¥Ç¥Ã¥¯¥¹¤òÆäËɽ¼¨¤·¤Ê¤¤ */
.\"O #define DS_LIB_ALARM_DONT_USE_SIG  11 /* don't use the alarm() signal */
#define DS_LIB_ALARM_DONT_USE_SIG  11 /* alarm() ¥·¥°¥Ê¥ë¤ò»È¤ï¤Ê¤¤ */
.\"O #define DS_LIB_PRINT_FULL_OID      12 /* print fully qualified oids */
#define DS_LIB_PRINT_FULL_OID      12 /* ´°Á´¤Ê oid ¤òɽ¼¨¤¹¤ë */
.\"O #define DS_LIB_QUICK_PRINT         13 /* print very brief output for parsing */
#define DS_LIB_QUICK_PRINT         13 /* ¥Ñ¡¼¥¹¤ÎºÝ¤ËÈó¾ï¤Ë´Êñ¤Ê½ÐÎϤò¤¹¤ë */
.\"O #define DS_LIB_RANDOM_ACCESS          14 /* random access to oid labels */
#define DS_LIB_RANDOM_ACCESS       14 /* oid ¥é¥Ù¥ë¤Ë¥é¥ó¥À¥à¤Ë¥¢¥¯¥»¥¹¤¹¤ë */
.\"O #define DS_LIB_REGEX_ACCESS           15 /* regex matching to oid labels */
#define DS_LIB_REGEX_ACCESS        15 /* oid ¥é¥Ù¥ë¤Ë regex ¤Ë¤è¤ë¥Þ¥Ã¥Á¥ó¥°¤ò¹Ô¤¦ */
.\"O #define DS_LIB_DONT_CHECK_RANGE    16 /* don't check values for ranges on send*/
#define DS_LIB_DONT_CHECK_RANGE    16 /* send ¤ÎÃͤÎÈϰϤΥÁ¥§¥Ã¥¯¤ò¹Ô¤ï¤Ê¤¤ */
.\"O #define DS_LIB_NO_TOKEN_WARNINGS   17 /* no warn about unknown config tokens */
#define DS_LIB_NO_TOKEN_WARNINGS   17 /* config ´Ø¿ô¤Î token ¤¬ÉÔÌÀ¤Ê¾ì¹ç¤Ç¤â·Ù¹ð¤ò½Ð¤µ¤Ê¤¤ */
.\"O #define DS_LIB_NUMERIC_TIMETICKS   18 /* print timeticks as a number */
#define DS_LIB_NUMERIC_TIMETICKS   18 /* timeticks ¤ò¿ôÃͤÇɽ¼¨¤¹¤ë */
.\"O #define DS_LIB_ESCAPE_QUOTES       19 /* shell escape quote marks in oids */
#define DS_LIB_ESCAPE_QUOTES       19 /* oid ¤Î°úÍÑÉä¤ò¥·¥§¥ë¤Ë¥¨¥¹¥±¡¼¥×¤µ¤»¤ë */
.\"O #define DS_LIB_REVERSE_ENCODE      20 /* encode packets from back to front */
#define DS_LIB_REVERSE_ENCODE      20 /* ¥Ð¥Ã¥¯¤«¤é¥Õ¥í¥ó¥È¤Ø¤Î¥Ñ¥±¥Ã¥È¤ò¥¨¥ó¥³¡¼¥É¤¹¤ë */
.\"O #define DS_LIB_PRINT_BARE_VALUE       21 /* just print value (not OID = value) */
#define DS_LIB_PRINT_BARE_VALUE    21 /* (OID = value ¤Ç¤Ê¤¤¾ì¹ç¤Î) value ¤À¤±¤òɽ¼¨¤¹¤ë */
.\"O #define DS_LIB_EXTENDED_INDEX         22 /* print extended index format [x1][x2] */
#define DS_LIB_EXTENDED_INDEX      22 /* [x1][x2] ¤È¤¤¤¦³ÈÄ¥·Á¼°¤Ç¥¤¥ó¥Ç¥Ã¥¯¥¹¤òɽ¼¨¤¹¤ë */

.\"O /* library integers */
/* À°¿ôÃͤòÁàºî¤¹¤ë¥é¥¤¥Ö¥é¥ê¤Ç»È¤ï¤ì¤ë¤â¤Î */
#define DS_LIB_MIB_WARNINGS  0
#define DS_LIB_SECLEVEL      1
#define DS_LIB_SNMPVERSION   2
#define DS_LIB_DEFAULT_PORT  3
.\"O #define DS_LIB_PRINT_SUFFIX_ONLY 4 /* print out only a single oid node  == 1.
.\"O                                       like #1 but supply mib module too == 2. */
#define DS_LIB_PRINT_SUFFIX_ONLY 4 /* oid node  == 1 ¤Î¤â¤Î¤òɽ¼¨¤¹¤ë¡£
                                      1 ÈÖÌܤȻ÷¤Æ¤¤¤ë¤¬¡¢mib ¥â¥¸¥å¡¼¥ë
                                      too == 2 ¤Î¤â¤Î¤òÍ¿¤¨¤ë¡£ */


.\"O /* library strings */
/* ʸ»úÎó¤òÁàºî¤¹¤ë¥é¥¤¥Ö¥é¥ê¤Ç»È¤ï¤ì¤ë¤â¤Î */
#define DS_LIB_SECNAME           0
#define DS_LIB_CONTEXT           1
#define DS_LIB_PASSPHRASE        2
#define DS_LIB_AUTHPASSPHRASE    3
#define DS_LIB_PRIVPASSPHRASE    4
#define DS_LIB_OPTIONALCONFIG    5
#define DS_LIB_APPTYPE           6
#define DS_LIB_COMMUNITY         7
#define DS_LIB_PERSISTENT_DIR    8
#define DS_LIB_CONFIGURATION_DIR 9

.fi
.\"O .SH FUNCTIONS
.SH ´Ø¿ô
.IP "ds_set_boolean(int storeid, int which, int value)"
.\"O Stores
.\"O .I true
.\"O if 
.\"O .I value
.\"O != 0 or else false into the bool_storage[storeid][which] slot.
.I value
!= 0 
¤Î¾ì¹ç¤Ï¡¢bool_storage[storeid][which] ¤Î¥¹¥í¥Ã¥È¤Ë
.I true
¤òÆþ¤ì¤ë¡£
¤½¤ì°Ê³°¤Î¾ì¹ç¤Ï
.I false
¤òÆþ¤ì¤ë¡£
.IP "int ds_get_boolean(int storeid, int which)"
.\"O Returns 1 if storage[storeid][which] is true, or 0 if false.
storage[storeid][which] ¤¬ true ¤Î¾ì¹ç¤Ï¡¢1 ¤òÊÖ¤¹¡£
¤½¤ì°Ê³°¤Î¾ì¹ç¤Ï¡¢0 ¤òÊÖ¤¹¡£
.IP "int ds_set_string(int storeid, int which, const char *value)"
.\"O Stores
.\"O .I value
.\"O into the string_storage[storeid][which] slot.
.I value
¤ò¥¹¥í¥Ã¥È string_storage[storeid][which] ¤ËÆþ¤ì¤ë¡£
.IP "char *ds_get_string(int storeid, int which)"
.\"O Returns the string which has been stored in the
.\"O string_storage[storeid][which] slot.
¥¹¥í¥Ã¥È string_storage[storeid][which] ¤ËÆþ¤Ã¤Æ¤¤¤ëʸ»úÎó¤òÊÖ¤¹¡£
.IP "ds_set_int(int storeid, int which, int value)"
.\"O Stores
.\"O .I value
.\"O into the int_storage[storeid][which] slot.
.I value
¤ò
¥¹¥í¥Ã¥È int_storage[storeid][which] ¤ËÆþ¤ì¤ë¡£
.IP "int ds_get_int(int storeid, int which)"
.\"O Returns the integer which has been stored in the
.\"O int_storage[storeid][which] slot.
¥¹¥í¥Ã¥È int_storage[storeid][which] ¤ËÆþ¤Ã¤Æ¤¤¤ëÀ°¿ôÃͤòÊÖ¤¹¡£
.IP "void ds_shutdown(void)"
.\"O Reclaims memory used to hold information gathered by
.\"O ds_register_config and ds_register_premib.
ds_register_config ¤È ds_register_premib ¤Ç½¸¤á¤¿¾ðÊó¤ò
ÊÝ»ý¤·¤Æ¤ª¤¯¤¿¤á¤Ë»È¤ï¤ì¤Æ¤¤¤ë¥á¥â¥ê¤ò²ó¼ý¤¹¤ë¡£
.IP "ds_register_config(u_char type, const char *ftype, const char *token, int storeid, int which)"
.\"O This token registers a configuration file directive and attaches it to 
.\"O a default storage type and slot.  Specifically,
.\"O .I storeid
.\"O and
.\"O .I which
.\"O indicate the storage slot in the data type indicated by
.\"O .I type,
.\"O where
.\"O .I type
.\"O is either one of the following constants: ASN_BOOLEAN, ASN_INTEGER, or
.\"O ASN_OCTET_STR.  
token ¤ÏÀßÄê¥Õ¥¡¥¤¥ë¤Î¥Ç¥£¥ì¥¯¥Æ¥£¥Ö¤òÅÐÏ¿¤·¡¢
¥Ç¥Õ¥©¥ë¥È¤Î³ÊǼ¥¿¥¤¥×¤È¥¹¥í¥Ã¥È¤Ë´ØÏ¢¤Å¤±¤ë¡£
Æäˡ¢
.I storeid
¤È
.I which
¤Ï
.I type
¥Ç¡¼¥¿·¿¤Î³ÊǼ¥¹¥í¥Ã¥È¤ò»Ø¤¹¡£
.I type
¤ÏÄê¿ô ASN_BOOLEAN, ASN_INTEGER, ASN_OCTET_STR ¤Î¤¤¤º¤ì¤« 1 ¤Ä¤Ç¤¢¤ë¡£
.\"O The
.\"O .I ftype
.\"O variable indicates the file name base string searched for the
.\"O .I token
.\"O keyword.  For example, the following call:
.I ftype
ÊÑ¿ô¤Ï
.I token
¥­¡¼¥ï¡¼¥É¤òõ¤¹¤¿¤á¤Î¥Õ¥¡¥¤¥ë̾¤Î¥Ù¡¼¥¹Ê¸»úÎó¤Ç¤¢¤ë¡£
Î㤨¤Ð¡¢
.RS
.IP
ds_register_config(ASN_INTEGER, "snmp", "testtoken", DS_APPLICATION_ID, 5)
.RE
.IP
.\"O would indicate that when the snmp.conf file(s) were found and parsed,
.\"O that any line beginning with the word "testtoken" should be read and
.\"O the value after "testtoken" should be stored into the
.\"O int_storage[DS_APPLICATION_ID][5] slot.  For example the following
.\"O line in the configuration file:
¤È¤¤¤¦¸Æ¤Ó½Ð¤·¤Ç¤Ï¡¢snmp.conf ¥Õ¥¡¥¤¥ë¤¬¸«¤Ä¤«¤Ã¤Æ¥Ñ¡¼¥¹¤µ¤ì¤ë¤È¤­¤Ë¡¢
"testtoken" ¤È¤¤¤¦¸ì¤Ç»Ï¤Þ¤ë¹Ô¤¬Æɤޤ졢
"testtoken" ¤Î¸å¤Ë¤¢¤ëÃͤ¬
¥¹¥í¥Ã¥È int_storage[DS_APPLICATION_ID][5] ¤Ë³ÊǼ¤µ¤ì¤ë¡£
Î㤨¤Ð¡¢ÀßÄê¥Õ¥¡¥¤¥ë¤Î
.RS
.IP
testtoken 42
.RE
.IP
¤È¤¤¤¦¹Ô¤Ç¤Ï¡¢int_storage[DS_APPLICATION_ID][5] = 42 ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
snmp_config(5), read_config(3)