Navigation


Changeset 972:ce3cacbbccc9 in freeDiameter for include/freeDiameter/libfdproto.h


Ignore:
Timestamp:
Mar 15, 2013, 1:31:00 AM (11 years ago)
Author:
Thomas Klausner <tk@giga.or.at>
Branch:
default
Phase:
public
Message:

Fix some typos.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/freeDiameter/libfdproto.h

    r965 r972  
    284284        TRACE(FD_LOG_DEBUG,(level),format,##args)
    285285
    286 /* Report a normal message that is usefull for normal admin monitoring */
     286/* Report a normal message that is useful for normal admin monitoring */
    287287#define TRACE_NOTICE(format,args... ) \
    288288        TRACE(FD_LOG_NOTICE,INFO,format,##args)
     
    312312int fd_breakhere(void);
    313313
    314 /* Helper for tracing the CHECK_* macros bellow -- very very verbose code execution! */
     314/* Helper for tracing the CHECK_* macros below -- very very verbose code execution! */
    315315#define TRACE_DEBUG_ALL( str )  \
    316316        TRACE_DEBUG(CALL, str );
     
    894894 *  type        : What kind of object must be created
    895895 *  data        : pointer to the data for the object.
    896  *               type parameter is used to determine the type of data (see bellow for detail).
     896 *               type parameter is used to determine the type of data (see below for detail).
    897897 *  parent      : a reference to a parent object, if needed.
    898898 *  ref         : upon successful creation, reference to new object is stored here if !null.
     
    918918 *  dict        : Pointer to the dictionnary where the object is searched
    919919 *  type        : type of object that is being searched
    920  *  criteria    : how the object must be searched. See object-related sections bellow for more information.
     920 *  criteria    : how the object must be searched. See object-related sections below for more information.
    921921 *  what        : depending on criteria, the data that must be searched.
    922922 *  result      : On successful return, pointer to the object is stored here.
     
    925925 * DESCRIPTION:
    926926 *   Perform a search in the dictionary.
    927  *   See the object-specific sections bellow to find how to look for each objects.
     927 *   See the object-specific sections below to find how to look for each objects.
    928928 *   If the "result" parameter is NULL, the function is used to check if an object is in the dictionary.
    929929 *   Otherwise, a reference to the object is stored in result if found.
     
    995995        VENDOR_BY_ID = 10,      /* "what" points to a vendor_id_t */
    996996        VENDOR_BY_NAME,         /* "what" points to a char * */
    997         VENDOR_OF_APPLICATION   /* "what" points to a struct dict_object containing an application (see bellow) */
     997        VENDOR_OF_APPLICATION   /* "what" points to a struct dict_object containing an application (see below) */
    998998};
    999999
     
    10651065        APPLICATION_BY_ID = 20,         /* "what" points to a application_id_t */
    10661066        APPLICATION_BY_NAME,            /* "what" points to a char * */
    1067         APPLICATION_OF_TYPE,            /* "what" points to a struct dict_object containing a type object (see bellow) */
    1068         APPLICATION_OF_COMMAND          /* "what" points to a struct dict_object containing a command (see bellow) */
     1067        APPLICATION_OF_TYPE,            /* "what" points to a struct dict_object containing a type object (see below) */
     1068        APPLICATION_OF_COMMAND          /* "what" points to a struct dict_object containing a command (see below) */
    10691069};
    10701070
     
    12061206enum {
    12071207        TYPE_BY_NAME = 30,              /* "what" points to a char * */
    1208         TYPE_OF_ENUMVAL,                /* "what" points to a struct dict_object containing an enumerated constant (DICT_ENUMVAL, see bellow). */
     1208        TYPE_OF_ENUMVAL,                /* "what" points to a struct dict_object containing an enumerated constant (DICT_ENUMVAL, see below). */
    12091209        TYPE_OF_AVP                     /* "what" points to a struct dict_object containing an AVP object. */
    12101210};
     
    12801280/* The criteria for searching a constant in the dictionary */
    12811281enum {
    1282         ENUMVAL_BY_STRUCT = 40, /* "what" points to a struct dict_enumval_request as defined bellow */
     1282        ENUMVAL_BY_STRUCT = 40, /* "what" points to a struct dict_enumval_request as defined below */
    12831283        ENUMVAL_BY_NAME,        /* This cannot be used for researches */
    12841284        ENUMVAL_BY_VALUE        /* This cannot be used for researches */
     
    14021402        AVP_BY_NAME,            /* "what" points to a char *, vendor is always 0 */
    14031403        AVP_BY_NAME_ALL_VENDORS,/* "what" points to a string. Might be quite slow... */
    1404         AVP_BY_STRUCT,          /* "what" points to a struct dict_avp_request_ex (see bellow) */
     1404        AVP_BY_STRUCT,          /* "what" points to a struct dict_avp_request_ex (see below) */
    14051405                       
    14061406        /* kept for backward compatibility, better use AVP_BY_STRUCT above instead */
    1407         AVP_BY_CODE_AND_VENDOR, /* "what" points to a struct dict_avp_request (see bellow), where avp_vendor and avp_code are set */
    1408         AVP_BY_NAME_AND_VENDOR  /* "what" points to a struct dict_avp_request (see bellow), where avp_vendor and avp_name are set */
     1407        AVP_BY_CODE_AND_VENDOR, /* "what" points to a struct dict_avp_request (see below), where avp_vendor and avp_code are set */
     1408        AVP_BY_NAME_AND_VENDOR  /* "what" points to a struct dict_avp_request (see below), where avp_vendor and avp_name are set */
    14091409};
    14101410
     
    16401640/* The criteria for searching a rule in the dictionary */
    16411641enum {
    1642         RULE_BY_AVP_AND_PARENT = 70     /* "what" points to a struct dict_rule_request -- see bellow. This is used to query "what is the rule for this AVP in this group?" */
     1642        RULE_BY_AVP_AND_PARENT = 70     /* "what" points to a struct dict_rule_request -- see below. This is used to query "what is the rule for this AVP in this group?" */
    16431643};
    16441644
     
    18531853 *  diamid        : a Diameter Identity, or NULL.
    18541854 *  diamidlen     : if diamid is \0-terminated, this can be 0. Otherwise, the length of diamid.
    1855  *  opt           : Additional string, or NULL. Usage is described bellow.
     1855 *  opt           : Additional string, or NULL. Usage is described below.
    18561856 *  optlen        : if opt is \0-terminated, this can be 0. Otherwise, the length of opt.
    18571857 *
     
    21362136};
    21372137
    2138 /* Some flags used in the functions bellow */
     2138/* Some flags used in the functions below */
    21392139#define AVPFL_SET_BLANK_VALUE      0x01 /* When creating an AVP, initialize its value to a blank area */
    21402140#define AVPFL_SET_RAWDATA_FROM_AVP 0x02 /* When creating an AVP, initialize its rawdata area from an existing AVP -- it is only blank padding (for error reporting) */
Note: See TracChangeset for help on using the changeset viewer.