[apple/network_cmds.git] / unbound / pythonmod / doc / modules / functions.rst

Scriptable functions
====================

Network
-------

.. function:: ntohs(netshort)

   This subroutine converts values between the host and network byte order. 
   Specifically, **ntohs()** converts 16-bit quantities from network byte order to host byte order.
   
   :param netshort: 16-bit short addr
   :rtype: converted addr
   
   
Cache
-----

.. function:: storeQueryInCache(qstate, qinfo, msgrep, is_referral)

   Store pending query in local cache.
   
   :param qstate: :class:`module_qstate`
   :param qinfo: :class:`query_info`
   :param msgrep: :class:`reply_info`
   :param is_referal: integer
   :rtype: boolean
   
.. function:: invalidateQueryInCache(qstate, qinfo)

   Invalidate record in local cache.

   :param qstate: :class:`module_qstate`
   :param qinfo: :class:`query_info`


Logging
-------

.. function:: verbose(level, msg)

   Log a verbose message, pass the level for this message.
   No trailing newline is needed.

   :param level: verbosity level for this message, compared to global verbosity setting.
   :param msg: string message

.. function:: log_info(msg)

   Log informational message. No trailing newline is needed.

   :param msg: string message

.. function:: log_err(msg)

   Log error message. No trailing newline is needed.

   :param msg: string message

.. function:: log_warn(msg)

   Log warning message. No trailing newline is needed.

   :param msg: string message

.. function:: log_hex(msg, data, length)

   Log a hex-string to the log. Can be any length.
   performs mallocs to do so, slow. But debug useful.

   :param msg: string desc to accompany the hexdump.
   :param data: data to dump in hex format.
   :param length: length of data.
   
.. function:: log_dns_msg(str, qinfo, reply)

   Log DNS message.
   
   :param str: string message
   :param qinfo: :class:`query_info`
   :param reply: :class:`reply_info`
   
.. function:: log_query_info(verbosity_value, str, qinf)

   Log query information.
   
   :param verbosity_value: see constants
   :param str: string message
   :param qinf: :class:`query_info`
   
.. function:: regional_log_stats(r)

   Log regional statistics.
   
   :param r: :class:`regional`

Debugging
---------

.. function:: strextstate(module_ext_state)

   Debug utility, module external qstate to string.
   
   :param module_ext_state: the state value.
   :rtype: descriptive string.

.. function:: strmodulevent(module_event)

   Debug utility, module event to string.
   
   :param module_event: the module event value.
   :rtype: descriptive string.
   
.. function:: ldns_rr_type2str(atype)

   Convert RR type to string.
   
.. function:: ldns_rr_class2str(aclass)

   Convert RR class to string.
Commit	Line	Data
89c4ed63 A	1	Scriptable functions
	2	====================
	3
	4	Network
	5	-------
	6
	7	.. function:: ntohs(netshort)
	8
	9	This subroutine converts values between the host and network byte order.
	10	Specifically, ntohs() converts 16-bit quantities from network byte order to host byte order.
	11
	12	:param netshort: 16-bit short addr
	13	:rtype: converted addr
	14
	15
	16	Cache
	17	-----
	18
	19	.. function:: storeQueryInCache(qstate, qinfo, msgrep, is_referral)
	20
	21	Store pending query in local cache.
	22
	23	:param qstate: :class:`module_qstate`
	24	:param qinfo: :class:`query_info`
	25	:param msgrep: :class:`reply_info`
	26	:param is_referal: integer
	27	:rtype: boolean
	28
	29	.. function:: invalidateQueryInCache(qstate, qinfo)
	30
	31	Invalidate record in local cache.
	32
	33	:param qstate: :class:`module_qstate`
	34	:param qinfo: :class:`query_info`
	35
	36
	37	Logging
	38	-------
	39
	40	.. function:: verbose(level, msg)
	41
	42	Log a verbose message, pass the level for this message.
	43	No trailing newline is needed.
	44
	45	:param level: verbosity level for this message, compared to global verbosity setting.
	46	:param msg: string message
	47
	48	.. function:: log_info(msg)
	49
	50	Log informational message. No trailing newline is needed.
	51
	52	:param msg: string message
	53
	54	.. function:: log_err(msg)
	55
	56	Log error message. No trailing newline is needed.
	57
	58	:param msg: string message
	59
	60	.. function:: log_warn(msg)
	61
	62	Log warning message. No trailing newline is needed.
	63
	64	:param msg: string message
65
66	.. function:: log_hex(msg, data, length)
67
68	Log a hex-string to the log. Can be any length.
69	performs mallocs to do so, slow. But debug useful.
70
71	:param msg: string desc to accompany the hexdump.
72	:param data: data to dump in hex format.
73	:param length: length of data.
74
75	.. function:: log_dns_msg(str, qinfo, reply)
76
77	Log DNS message.
78
79	:param str: string message
80	:param qinfo: :class:`query_info`
81	:param reply: :class:`reply_info`
82
83	.. function:: log_query_info(verbosity_value, str, qinf)
84
85	Log query information.
86
87	:param verbosity_value: see constants
88	:param str: string message
89	:param qinf: :class:`query_info`
90
91	.. function:: regional_log_stats(r)
92
93	Log regional statistics.
94
95	:param r: :class:`regional`
96
97	Debugging
98	---------
99
100	.. function:: strextstate(module_ext_state)
101
102	Debug utility, module external qstate to string.
103
104	:param module_ext_state: the state value.
105	:rtype: descriptive string.
106
107	.. function:: strmodulevent(module_event)
108
109	Debug utility, module event to string.
110
111	:param module_event: the module event value.
112	:rtype: descriptive string.
113
114	.. function:: ldns_rr_type2str(atype)
115
116	Convert RR type to string.
117
118	.. function:: ldns_rr_class2str(aclass)
119
120	Convert RR class to string.