Navigation

Changeset 972:ce3cacbbccc9 in freeDiameter for include


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.

Location:
include/freeDiameter
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • include/freeDiameter/libfdcore.h

    r968 r972  
    225225        (((unsigned)(state)) <= STATE_MAX ? peer_state_str[((unsigned)(state)) ] : "<Invalid>")
    226226
    227 /* Constants for the peer_info structure bellow */
     227/* Constants for the peer_info structure below */
    228228#define PI_P3_DEFAULT   0       /* Use any available protocol */
    229229#define PI_P3_IP        1       /* Use only IP to connect to this peer */
    … …  
    406406 *
    407407 * PARAMETERS:
    408  *  peer_validate       : Callback as defined bellow.
     408 *  peer_validate       : Callback as defined below.
    409409 *
    410410 * DESCRIPTION:
    … …  
    589589 *   - The process is the same as for IN messages, until the routing-in threads makes its decision that the message is not handled locally.
    590590 *   - If the local peer does not relay message, an error DIAMETER_APPLICATION_UNSUPPORTED is returned.
    591  *   - All callbacks registered with fd_rt_fwd_register are called for the message (see bellow).
     591 *   - All callbacks registered with fd_rt_fwd_register are called for the message (see below).
    592592 *     - these callbacks will typically do proxying work. Note that adding the route-record is handled by the daemon.
    593593 *   - Once all callbacks have been called, the message is queued in the global fd_g_outgoing queue.
    594  *   - The remaining processing is the same as for OUT messages, as described bellow.
     594 *   - The remaining processing is the same as for OUT messages, as described below.
    595595 *
    596596 * (*) OUT messages details:
    … …  
    602602 *   - If the list is empty, create an error UNABLE_TO_DELIVER (note: should we trig dynamic discovery here???) and reply.
    603603 *   - Otherwise, call all callbacks registered by function fd_rt_out_register, with the list of peers and the message.
    604  *   - Order the resulting list of peers by score (see bellow), and sent the message to the peer with highest (positive) score.
     604 *   - Order the resulting list of peers by score (see below), and sent the message to the peer with highest (positive) score.
    605605 *    - in case the peer is no longer in the "OPEN" state, send the message to the second peer in the list.
    606606 *      - if no peer is in OPEN state anymore, restart the process of creating the list.
    … …  
    626626 *
    627627 * PARAMETERS:
    628  *  rt_fwd_cb     : The callback function to register (see prototype bellow).
     628 *  rt_fwd_cb     : The callback function to register (see prototype below).
    629629 *  cbdata        : Pointer to pass to the callback when it is called. The data is opaque to the daemon.
    630630 *  dir           : One of the RT_FWD_* directions defined above.
    … …  
    703703 *
    704704 * PARAMETERS:
    705  *  rt_out_cb     : The callback function to register (see prototype bellow).
     705 *  rt_out_cb     : The callback function to register (see prototype below).
    706706 *  cbdata        : Pointer to pass to the callback when it is called. The data is opaque to the daemon.
    707707 *  priority      : Order for calling this callback. The callbacks are called in reverse priority order (higher priority = called sooner).

  • 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.