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
|
<!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.3.1"/>
<title>Libical: icalcstpserver.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">Libical
 <span id="projectnumber">1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e5788c73bf8d77f47d4a3002d26bfd20.html">libicalss</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">icalcstpserver.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*======================================================================</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> FILE: icalcstpserver.h</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> CREATOR: eric 13 Feb 01</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> $Id: icalcstpserver.h,v 1.3 2008-01-02 20:15:45 dothebart Exp $</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom, http://www.softwarestudio.org</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This program is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> it under the terms of either: </span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> The LGPL as published by the Free Software Foundation, version</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> 2.1, available at: http://www.fsf.org/copyleft/lesser.html</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> Or:</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> The Mozilla Public License Version 1.0. You may obtain a copy of</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> the License at http://www.mozilla.org/MPL/</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> The original code is icalcstp.h</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">======================================================================*/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifndef ICALCSTPS_H</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#define ICALCSTPS_H</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <libical/ical.h></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/********************** Server (Reciever) Interfaces *************************/</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/* On the server side, the caller will recieve data from the incoming</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> socket and pass it to icalcstps_next_input. The caller then takes</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> the return from icalcstps_next_outpu and sends it out through the</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> socket. This gives the caller a point of control. If the cstp code</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> connected to the socket itself, it would be hard for the caller to</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> do anything else after the cstp code was started.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> All of the server and client command routines will generate</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> response codes. On the server side, these responses will be turned</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> into text and sent to the client. On the client side, the reponse</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> is the one sent from the server.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> Since each command can return multiple responses, the responses are</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> stored in the icalcstps object and are accesses by</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> icalcstps_first_response() and icalcstps_next_response()</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> How to use: </span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> 1) Construct a new icalcstps, bound to your code via stubs</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> 2) Repeat forever:</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> 2a) Get string from client & give to icalcstps_next_input()</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> 2b) Repeat until icalcstp_next_output returns 0:</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> 2b1) Call icalcstps_next_output. </span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> 2b2) Send string to client.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> icalcstps;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/* Pointers to the rountines that</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> icalcstps_process_incoming will call when it recognizes a CSTP</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> command in the data. BTW, the CONTINUE command is named 'cont'</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> because 'continue' is a C keyword */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="structicalcstps__commandfp.html"> 70</a></span> <span class="keyword">struct </span><a class="code" href="structicalcstps__commandfp.html">icalcstps_commandfp</a> {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  icalerrorenum (*abort)(icalcstps* cstp);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  icalerrorenum (*authenticate)(icalcstps* cstp, <span class="keywordtype">char</span>* mechanism,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">char</span>* data);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  icalerrorenum (*calidexpand)(icalcstps* cstp, <span class="keywordtype">char</span>* calid);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  icalerrorenum (*capability)(icalcstps* cstp);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  icalerrorenum (*cont)(icalcstps* cstp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> time);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  icalerrorenum (*identify)(icalcstps* cstp, <span class="keywordtype">char</span>* id);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  icalerrorenum (*disconnect)(icalcstps* cstp);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  icalerrorenum (*sendata)(icalcstps* cstp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> time,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  icalerrorenum (*starttls)(icalcstps* cstp, <span class="keywordtype">char</span>* command,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">char</span>* data);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  icalerrorenum (*upnexpand)(icalcstps* cstp, <span class="keywordtype">char</span>* upn);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  icalerrorenum (*unknown)(icalcstps* cstp, <span class="keywordtype">char</span>* command, <span class="keywordtype">char</span>* data);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> }; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> icalcstps* icalcstps_new(<span class="keyword">struct</span> <a class="code" href="structicalcstps__commandfp.html">icalcstps_commandfp</a> stubs);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">void</span> icalcstps_free(icalcstps* cstp);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">int</span> icalcstps_set_timeout(icalcstps* cstp, <span class="keywordtype">int</span> sec);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/* Get the next string to send to the client */</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">char</span>* icalcstps_next_output(icalcstps* cstp);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/* process the next string from the client */</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">int</span> icalcstps_next_input(icalcstps* cstp);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif </span><span class="comment">/* ICALCSTPS */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></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.3.1
</small></address>
</body>
</html>
|
