node-set.m2i
上传用户:wxp200602
上传日期:2007-10-30
资源大小:4028k
文件大小:7k
源码类别:

SNMP编程

开发平台:

Unix_Linux

  1. #############################################################  -*- c -*-
  2. ## generic include for XXX. Do not use directly.
  3. ##
  4. ## $Id: node-set.m2i,v 1.20 2004/10/15 00:45:05 rstory Exp $
  5. ########################################################################
  6. @if $m2c_mark_boundary == 1@
  7. /** START code generated by $RCSfile: node-set.m2i,v $ $Revision: 1.20 $ */
  8. @end@
  9. ########################################################################
  10. ##
  11. ##----------------------------------------------------------------------
  12. /**
  13.  * Check that the proposed new value is potentially valid.
  14.  *
  15.  * @param rowreq_ctx
  16.  *        Pointer to the row request context.
  17.  * @param $m2c_node_param_val_name
  18.  *        A $node.decl containing the new value.
  19. @    if $m2c_node_needlength == 1@
  20.  * @param $m2c_node_param_val_lname
  21.  *        The size (in bytes) of the data pointed to by $m2c_node_param_val_name
  22. @    end@
  23.  *
  24.  * @retval MFD_SUCCESS        : incoming value is legal
  25.  * @retval MFD_NOT_VALID_NOW  : incoming value is not valid now
  26.  * @retval MFD_NOT_VALID_EVER : incoming value is never valid
  27.  *
  28.  * This is the place to check for requirements that are not
  29.  * expressed in the mib syntax (for example, a requirement that
  30.  * is detailed in the description for an object).
  31.  *
  32.  * You should check that the requested change between the undo value and the
  33.  * new value is legal (ie, the transistion from one value to another
  34.  * is legal).
  35.  *      
  36.  *@note
  37.  * This check is only to determine if the new value
  38.  * is b potentially valid. This is the first check of many, and
  39.  * is one of the simplest ones.
  40.  * 
  41.  *@note
  42.  * this is not the place to do any checks for values
  43.  * which depend on some other value in the mib. Those
  44.  * types of checks should be done in the
  45.  * ${context}_check_dependencies() function.
  46.  *
  47.  * The following checks have already been done for you:
  48.  *    The syntax is $node.type
  49. @if $node.enums == 1@
  50.  *    The value is one of $m2c_evals
  51. @elsif $node.ranges == 1@
  52. @    if ("$node.decl" eq "long") || ("$node.decl" eq "u_long")@
  53. @        eval $m2c_tmp_ns = "value"@
  54. @    else@
  55. @        eval $m2c_tmp_ns = "length"@
  56. @    end@
  57.  *    The $m2c_tmp_ns is in (one of) the range set(s): $m2c_evals
  58. @end@
  59.  *
  60.  * If there a no other checks you need to do, simply return MFD_SUCCESS.
  61.  *
  62. @  if $mfd_code_verbose == 1@
  63. @    if ("$node.decl" eq "long") || ("$node.decl" eq "u_long")@
  64.  * For example, an object with the syntax INTEGER(0..500) will
  65.  * have already been checked for a value between 0 and 500. But
  66.  * if the description also specifies that the value must be an
  67.  * even number, you would enforce that requirement here. If and odd
  68.  * numer is set, return MFD_NOT_VALID_EVER. If the description also
  69.  * specified that changed must be made in single steps of 2, then a set
  70.  * to change the value 10 to an even value other than 8 or 12 should
  71.  * return MFD_NOT_VALID_NOW.
  72. @    else@
  73.  * For example, and object with the syntax DisplayString(0..40)
  74.  * will have already been checked for a length between 0 and 40.
  75.  * But if the description also specified that the value must
  76.  * be all uppercase letters, you would enforce that requirement here
  77.  * by returning MFD_NOT_VALID_EVER for a set containing lowercase
  78.  * letters. If the description also specified that the value can not
  79.  * change by more than one letter at a time, an attempt to change
  80.  * "ABBY" to "ANNIE" should return MFD_NOT_VALID_NOW.
  81. @    end@
  82.  *
  83. @  end@
  84.  */
  85. int
  86. ${node}_check_value( ${context}_rowreq_ctx *rowreq_ctx, $m2c_node_param_val)
  87. {
  88.     DEBUGMSGTL(("verbose:${context}:${node}_check_value","calledn"));
  89.     /** should never get a NULL pointer */
  90.     netsnmp_assert(NULL != rowreq_ctx);
  91. @if $m2c_node_needlength == 1@
  92.     netsnmp_assert(NULL != $m2c_node_param_val_name);
  93. @end@
  94.     /*
  95.      * TODO:441:o: |-> Check for valid $node value.
  96.      */
  97.     return MFD_SUCCESS; /* $node value not illegal */
  98. } /* ${node}_check_value */
  99. ##----------------------------------------------------------------------
  100. /**
  101.  * Save old value information
  102.  *
  103.  * @param rowreq_ctx
  104.  *        Pointer to the table context (${context}_rowreq_ctx)
  105.  *
  106.  * @retval MFD_SUCCESS : success
  107.  * @retval MFD_ERROR   : error. set will fail.
  108.  *
  109.  * This function will be called after the table level undo setup function
  110.  * ${context}_undo_setup has been called.
  111.  *
  112.  *@note
  113.  * this function will only be called if a new value is set for this column.
  114.  *
  115.  * If there is any setup specific to a particular column (e.g. allocating
  116.  * memory for a string), you should do that setup in this function, so it
  117.  * won't be done unless it is necessary.
  118.  */
  119. int
  120. ${node}_undo_setup( ${context}_rowreq_ctx *rowreq_ctx)
  121. {
  122.     DEBUGMSGTL(("verbose:${context}:${node}_undo_setup","calledn"));
  123. @ifconf syntax-$node.syntax-undo-setup.m2i@
  124. @    include syntax-$node.syntax-undo-setup.m2i@
  125. @else@
  126.     /** should never get a NULL pointer */
  127.     netsnmp_assert(NULL != rowreq_ctx);
  128.     /*
  129.      * TODO:455:o: |-> Setup $node undo.
  130.      */
  131. @   eval $m2c_ctx_lh = "${m2c_undo_item}${node}"@
  132. @   eval $m2c_ctx_lhs = "${m2c_undo_item}${node}_len"@
  133. @   eval $m2c_ctx_rh = "${m2c_data_item}${node}"@
  134. @   eval $m2c_ctx_rhs = "${m2c_data_item}${node}_len"@
  135. @   include generic-ctx-copy.m2i@
  136. @end@
  137.     return MFD_SUCCESS;
  138. } /* ${node}_undo_setup */
  139. ##----------------------------------------------------------------------
  140. /**
  141.  * Set the new value.
  142.  *
  143. @if $m2c_node_set_comments ne ""@
  144. $m2c_node_set_comments
  145. *
  146. @end@
  147.  * @param rowreq_ctx
  148.  *        Pointer to the users context. You should know how to
  149.  *        manipulate the value from this object.
  150.  * @param $m2c_node_param_val_name
  151.  *        A $node.decl containing the new value.
  152. @    if $m2c_node_needlength == 1@
  153.  * @param $m2c_node_param_val_lname
  154.  *        The size (in bytes) of the data pointed to by $m2c_node_param_val_name
  155. @    end@
  156.  */
  157. int
  158. ${node}_set( ${context}_rowreq_ctx *rowreq_ctx, $m2c_node_param_val )
  159. {
  160. @ifconf syntax-$node.syntax-set.m2i@
  161. @    include syntax-$node.syntax-set.m2i@
  162. @else@
  163.     DEBUGMSGTL(("verbose:${context}:${node}_set","calledn"));
  164.     /** should never get a NULL pointer */
  165.     netsnmp_assert(NULL != rowreq_ctx);
  166. @if $m2c_node_needlength == 1@
  167.     netsnmp_assert(NULL != $m2c_node_param_val_name);
  168. @end@
  169. @    if $m2c_node_skip_mapping != 1@
  170. @        include generic-value-map-reverse.m2i@
  171. @    end@
  172. @    if ($node.enums != 1) || ("$node.perltype" ne "BITS")@
  173. @        include generic-ctx-set.m2i@
  174. @    end@ # ! enums & bits
  175. @end@ # no syntax include
  176.     return MFD_SUCCESS;
  177. } /* ${node}_set */
  178. ##----------------------------------------------------------------------
  179. /**
  180.  * undo the previous set.
  181.  *
  182. @if $m2c_node_undo_comments ne ""@
  183. $m2c_node_undo_comments
  184. *
  185. @end@
  186.  * @param rowreq_ctx
  187.  *        Pointer to the users context.
  188.  */
  189. int
  190. ${node}_undo( ${context}_rowreq_ctx *rowreq_ctx)
  191. {
  192. @ifconf syntax-$node.syntax-undo.m2i@
  193. @    include syntax-$node.syntax-undo.m2i@
  194. @else@
  195.     DEBUGMSGTL(("verbose:${context}:${node}_undo","calledn"));
  196.     netsnmp_assert(NULL != rowreq_ctx);
  197.     /*
  198.      * TODO:456:o: |-> Clean up $node undo.
  199.      */
  200. @   eval $m2c_ctx_rh = "${m2c_undo_item}${node}"@
  201. @   eval $m2c_ctx_rhs = "${m2c_undo_item}${node}_len"@
  202. @   eval $m2c_ctx_lh = "${m2c_data_item}${node}"@
  203. @   eval $m2c_ctx_lhs = "${m2c_data_item}${node}_len"@
  204. @   include generic-ctx-copy.m2i@
  205. @end@ # no syntax include
  206.     
  207.     return MFD_SUCCESS;
  208. } /* ${node}_undo */
  209. ##
  210. ########################################################################
  211. @if $m2c_mark_boundary == 1@
  212. /** END code generated by $RCSfile: node-set.m2i,v $ $Revision: 1.20 $ */
  213. @end@