/usr/share/doc/kildclient/html/ch16s01.xhtml is in kildclient-doc 3.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>16.1. Receiving server data</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="chap_serverdata.xhtml" title="Chapter 16. Out-of-band server data"/><link rel="next" href="sec_sending_server_data.xhtml" title="16.2. Sending server data"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">16.1. Receiving server data</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="chap_serverdata.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 16. Out-of-band server data</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="sec_sending_server_data.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm2896"><div class="titlepage"><div><div><h2 class="title" style="clear: both">16.1. Receiving server data</h2></div></div></div><p>As mentinoed previously, to receive server data, bind a hook to
the <code class="literal">OnServerData</code> event. See <a class="xref" href="chap_hooks.xhtml" title="Chapter 12. Hooks">Chapter 12, <em>Hooks</em></a>.</p><p>Inside the hook, the <code class="varname">%::server_data</code> variable
holds the data received. The elements of the hash can vary depending
on the protocol and what was received. To view what is received in each message, you can use the <code class="literal">serverdatadumper</code> plugin. Just load it, and whenever a server data message is received, the contents of the <code class="varname">%::server_data</code> will be displayed.</p><p>Here's a general description of the elements, followed by
specifics to each protocol if appropriate:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">$::server_data{'protocol'}</code> hold
the protocol used to send the data. It will be
<code class="literal">MSDP</code> or
<code class="literal">GMCP</code>.</p></li><li class="listitem"><p><code class="varname">$::server_data{'data'}</code> holds the
data received. The actual contents vary depending on what has been
received, but in most cases it will be a reference to a hash with
entries for each variable sent by the server. If the value is
<code class="literal">undef</code>, that means that the server sent the
null/undefined object (this is not possible in all protocols). If
this key does not exist in the hash, the server did not send any
variables at all (again, not possible in all
protocols).</p></li><li class="listitem"><p><code class="varname">$::server_data{'error'}</code> is set in
case KildClient could not parse the data sent by the server. In this
case, this variable holds the error message, and
<code class="varname">$::server_data{'data'}</code> contains the raw data
received.</p></li></ul></div><section class="sect2" id="idm2921"><div class="titlepage"><div><div><h3 class="title">16.1.1. GMCP data</h3></div></div></div><p>The GMCP protocol has the concept of packages (with optional
subpackages) and message names. These are stored in
<code class="varname">$::server_data{'package'}</code>,
<code class="varname">$::server_data{'subpackage'}</code> and
<code class="varname">$::server_data{'message'}</code> if they are included in
the message.</p><p>The actual data in this protocol is sent using the JSON format.
The Perl module JSON is used to parse the data, see its documentation
if you want specific details on how objects are represented.</p></section></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="chap_serverdata.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_serverdata.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="sec_sending_server_data.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">Chapter 16. Out-of-band server data </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> 16.2. Sending server data</td></tr></table></div></footer></body></html>
|