/usr/share/doc/libmeanwhile-dev/html/structmwSessionHandler.html is in libmeanwhile-dev 1.0.2-7.
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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>meanwhile: mwSessionHandler Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">meanwhile
 <span id="projectnumber">1.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">mwSessionHandler Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>session handler.
<a href="structmwSessionHandler.html#details">More...</a></p>
<p><code>#include <<a class="el" href="mw__session_8h_source.html">mw_session.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa88b275b623ac2b0b72e1b77a5205c07"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#aa88b275b623ac2b0b72e1b77a5205c07">clear</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *)</td></tr>
<tr class="memdesc:aa88b275b623ac2b0b72e1b77a5205c07"><td class="mdescLeft"> </td><td class="mdescRight">triggered by mwSession_free. <a href="#aa88b275b623ac2b0b72e1b77a5205c07">More...</a><br /></td></tr>
<tr class="separator:aa88b275b623ac2b0b72e1b77a5205c07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a846ffbcb6de5e47ccd1b013e8a55aec6"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#a846ffbcb6de5e47ccd1b013e8a55aec6">io_close</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *)</td></tr>
<tr class="memdesc:a846ffbcb6de5e47ccd1b013e8a55aec6"><td class="mdescLeft"> </td><td class="mdescRight">close the server connection. <a href="#a846ffbcb6de5e47ccd1b013e8a55aec6">More...</a><br /></td></tr>
<tr class="separator:a846ffbcb6de5e47ccd1b013e8a55aec6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e36153e642ec8e5c47502172288abd0"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#a9e36153e642ec8e5c47502172288abd0">io_write</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *, const guchar *buf, gsize len)</td></tr>
<tr class="memdesc:a9e36153e642ec8e5c47502172288abd0"><td class="mdescLeft"> </td><td class="mdescRight">write data to the server connection. <a href="#a9e36153e642ec8e5c47502172288abd0">More...</a><br /></td></tr>
<tr class="separator:a9e36153e642ec8e5c47502172288abd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8c5f832e22ac4a451290afa7b9e0bc9"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#ae8c5f832e22ac4a451290afa7b9e0bc9">on_admin</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *, const char *text)</td></tr>
<tr class="memdesc:ae8c5f832e22ac4a451290afa7b9e0bc9"><td class="mdescLeft"> </td><td class="mdescRight">called when an admin messages has been received <a href="#ae8c5f832e22ac4a451290afa7b9e0bc9">More...</a><br /></td></tr>
<tr class="separator:ae8c5f832e22ac4a451290afa7b9e0bc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada29bbfca164eafb635f4f5321faaa98"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#ada29bbfca164eafb635f4f5321faaa98">on_announce</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *, struct <a class="el" href="structmwLoginInfo.html">mwLoginInfo</a> *from, gboolean may_reply, const char *text)</td></tr>
<tr class="memdesc:ada29bbfca164eafb635f4f5321faaa98"><td class="mdescLeft"> </td><td class="mdescRight">called when an announcement arrives <a href="#ada29bbfca164eafb635f4f5321faaa98">More...</a><br /></td></tr>
<tr class="separator:ada29bbfca164eafb635f4f5321faaa98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace0c94acef85320785a75f8a8d582c52"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#ace0c94acef85320785a75f8a8d582c52">on_setPrivacyInfo</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *)</td></tr>
<tr class="memdesc:ace0c94acef85320785a75f8a8d582c52"><td class="mdescLeft"> </td><td class="mdescRight">called when privacy information has been sent or received <a href="#ace0c94acef85320785a75f8a8d582c52">More...</a><br /></td></tr>
<tr class="separator:ace0c94acef85320785a75f8a8d582c52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdaf83db7841763e254b392f01eb26e7"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#abdaf83db7841763e254b392f01eb26e7">on_setUserStatus</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *)</td></tr>
<tr class="memdesc:abdaf83db7841763e254b392f01eb26e7"><td class="mdescLeft"> </td><td class="mdescRight">called when user status has changed <a href="#abdaf83db7841763e254b392f01eb26e7">More...</a><br /></td></tr>
<tr class="separator:abdaf83db7841763e254b392f01eb26e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a769f4b8077aac6e154547b194147e037"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwSessionHandler.html#a769f4b8077aac6e154547b194147e037">on_stateChange</a> )(struct <a class="el" href="structmwSession.html">mwSession</a> *s, enum <a class="el" href="mw__session_8h.html#af27bba1d2fcb53358371c0eca6c57a8f">mwSessionState</a> state, gpointer info)</td></tr>
<tr class="memdesc:a769f4b8077aac6e154547b194147e037"><td class="mdescLeft"> </td><td class="mdescRight">Called when the session has changed status. <a href="#a769f4b8077aac6e154547b194147e037">More...</a><br /></td></tr>
<tr class="separator:a769f4b8077aac6e154547b194147e037"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>session handler. </p>
<p>Structure which interfaces a session with client code to provide I/O and event handling </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aa88b275b623ac2b0b72e1b77a5205c07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::clear) (struct <a class="el" href="structmwSession.html">mwSession</a> *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>triggered by mwSession_free. </p>
<p>Optional. Put cleanup code here </p>
</div>
</div>
<a class="anchor" id="a846ffbcb6de5e47ccd1b013e8a55aec6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::io_close) (struct <a class="el" href="structmwSession.html">mwSession</a> *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>close the server connection. </p>
<p>Required </p>
</div>
</div>
<a class="anchor" id="a9e36153e642ec8e5c47502172288abd0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* mwSessionHandler::io_write) (struct <a class="el" href="structmwSession.html">mwSession</a> *, const guchar *buf, gsize len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>write data to the server connection. </p>
<p>Required. Should return zero for success, non-zero for error </p>
</div>
</div>
<a class="anchor" id="ae8c5f832e22ac4a451290afa7b9e0bc9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::on_admin) (struct <a class="el" href="structmwSession.html">mwSession</a> *, const char *text)</td>
</tr>
</table>
</div><div class="memdoc">
<p>called when an admin messages has been received </p>
</div>
</div>
<a class="anchor" id="ada29bbfca164eafb635f4f5321faaa98"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::on_announce) (struct <a class="el" href="structmwSession.html">mwSession</a> *, struct <a class="el" href="structmwLoginInfo.html">mwLoginInfo</a> *from, gboolean may_reply, const char *text)</td>
</tr>
</table>
</div><div class="memdoc">
<p>called when an announcement arrives </p>
</div>
</div>
<a class="anchor" id="ace0c94acef85320785a75f8a8d582c52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::on_setPrivacyInfo) (struct <a class="el" href="structmwSession.html">mwSession</a> *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>called when privacy information has been sent or received </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="mw__session_8h.html#af40d8491fa06d6386414f8bd54d33e04" title="direct reference to the session's internal privacy structure ">mwSession_getPrivacyInfo</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abdaf83db7841763e254b392f01eb26e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::on_setUserStatus) (struct <a class="el" href="structmwSession.html">mwSession</a> *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>called when user status has changed </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="mw__session_8h.html#a394f76a8608dedd50c4984364649c150">mwSession_getUserStatus</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a769f4b8077aac6e154547b194147e037"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* mwSessionHandler::on_stateChange) (struct <a class="el" href="structmwSession.html">mwSession</a> *s, enum <a class="el" href="mw__session_8h.html#af27bba1d2fcb53358371c0eca6c57a8f">mwSessionState</a> state, gpointer info)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when the session has changed status. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="mw__session_8h.html#a4ccd4606756bf065c52ed31d59fb4482" title="additional status-specific information. ">mwSession_getStateInfo</a> for uses of info field</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>the session </td></tr>
<tr><td class="paramname">state</td><td>the session's state </td></tr>
<tr><td class="paramname">info</td><td>additional state information </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mw__session_8h_source.html">mw_session.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|