소스 검색

htable: docs for rpc command htable.setex

Daniel-Constantin Mierla 3 년 전
부모
커밋
2b9c0a5fbc
1개의 변경된 파일30개의 추가작업 그리고 0개의 파일을 삭제
  1. 30 0
      src/modules/htable/doc/htable_admin.xml

+ 30 - 0
src/modules/htable/doc/htable_admin.xml

@@ -1475,6 +1475,36 @@ kamcmd htable.seti test x 123
 # Set first entry in array key x $sht(test=>x[0]) as integer
 kamcmd htable.seti test x[0] 123
 ...
+</programlisting>
+	</section>
+	</section>
+       <section id="htable.rpc.setex">
+                <title>
+                <function moreinfo="none">htable.setex htable key expire</function>
+                </title>
+                <para>
+					Set the expire for an item in hash table.
+                </para>
+                <para>
+                Name: <emphasis>htable.setex</emphasis>
+                </para>
+                <para>Parameters:</para>
+                <itemizedlist>
+                        <listitem><para>htable : name of the hash table</para>
+                        </listitem>
+                        <listitem><para>key : key name in the hash table</para>
+                        </listitem>
+                        <listitem><para>expire : integer value for the expire (seconds)</para>
+                        </listitem>
+                </itemizedlist>
+                <para>
+                Example:
+                </para>
+<programlisting  format="linespecific">
+...
+# set  expire for $sht(test=>x) to 120 secs
+kamctl rpc htable.seti test x 120
+...
 </programlisting>
 	</section>
         <section id="htable.rpc.dump">