diff options
Diffstat (limited to 'apidocs/icalcstpclient_8h_source.html')
-rw-r--r-- | apidocs/icalcstpclient_8h_source.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/apidocs/icalcstpclient_8h_source.html b/apidocs/icalcstpclient_8h_source.html new file mode 100644 index 00000000..7e808f98 --- /dev/null +++ b/apidocs/icalcstpclient_8h_source.html @@ -0,0 +1,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: icalcstpclient.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">icalcstpclient.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: icalcstpclient.h</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> CREATOR: eric 4 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: icalcstpclient.h,v 1.3 2008-01-02 20:15:44 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 ICALCSTPC_H</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#define ICALCSTPC_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> <span class="preprocessor">#include <libicalss/icalcstp.h></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">/********************** Client (Sender) 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">/* How to use: </span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> 1) Construct a new icalcstpc</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> 2) Issue a command by calling one of the command routines. </span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> 3) Repeat until both call icalcstpc_next_output and</span></div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> icalcstpc_next_input return 0:</span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> 3a) Call icalcstpc_next_output. Send string to server. </span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> 3b) Get string from server, & give to icalcstp_next_input()</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> 4) Iterate with icalcstpc_first_response & icalcstp_next_response to </span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> get the servers responses</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> 5) Repeat at #2</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> </div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> icalcstpc;</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/* Response code sent by the server. */</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="structicalcstpc__response.html"> 52</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structicalcstpc__response.html">icalcstpc_response</a> { </div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  icalrequeststatus code;</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">char</span> *arg; <span class="comment">/* These strings are owned by libical */</span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">char</span> *debug_text;</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">char</span> *more_text;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span>* result;</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <a class="code" href="structicalcstpc__response.html">icalcstpc_response</a>;</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</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> icalcstpc* icalcstpc_new();</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="keywordtype">void</span> icalcstpc_free(icalcstpc* cstpc);</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="keywordtype">int</span> icalcstpc_set_timeout(icalcstpc* cstp, <span class="keywordtype">int</span> sec);</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/* Get the next string to send to the server */</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">char</span>* icalcstpc_next_output(icalcstpc* cstp, <span class="keywordtype">char</span>* line);</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">char</span>* icalcstpc_next_output_r(icalcstpc* cstp, <span class="keywordtype">char</span>* line);</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/* process the next string from the server */</span> </div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> icalcstpc_next_input(icalcstpc* cstp, <span class="keywordtype">char</span> * line);</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/* After icalcstpc_next_input returns a 0, there are responses</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> ready. use these to get them */</span></div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <a class="code" href="structicalcstpc__response.html">icalcstpc_response</a> icalcstpc_first_response(icalcstpc* cstp);</div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <a class="code" href="structicalcstpc__response.html">icalcstpc_response</a> icalcstpc_next_response(icalcstpc* cstp);</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* Issue a command */</span></div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> icalerrorenum icalcstpc_abort(icalcstpc* cstp);</div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> icalerrorenum icalcstpc_authenticate(icalcstpc* cstp, <span class="keywordtype">char</span>* mechanism, </div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">char</span>* init_data, <span class="keywordtype">char</span>* f(<span class="keywordtype">char</span>*) );</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> icalerrorenum icalcstpc_capability(icalcstpc* cstp);</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> icalerrorenum icalcstpc_calidexpand(icalcstpc* cstp,<span class="keywordtype">char</span>* calid);</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> icalerrorenum icalcstpc_continue(icalcstpc* cstp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> time);</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> icalerrorenum icalcstpc_disconnect(icalcstpc* cstp);</div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> icalerrorenum icalcstpc_identify(icalcstpc* cstp, <span class="keywordtype">char</span>* <span class="keywordtype">id</span>);</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> icalerrorenum icalcstpc_starttls(icalcstpc* cstp, <span class="keywordtype">char</span>* command, </div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">char</span>* init_data, <span class="keywordtype">char</span>* f(<span class="keywordtype">char</span>*));</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> icalerrorenum icalcstpc_senddata(icalcstpc* cstp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> time,</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> icalerrorenum icalcstpc_upnexpand(icalcstpc* cstp,<span class="keywordtype">char</span>* calid);</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> icalerrorenum icalcstpc_sendata(icalcstpc* cstp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> time,</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </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="preprocessor">#endif </span><span class="comment">/* !ICALCSTPC_H */</span><span class="preprocessor"></span></div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"></span></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> </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> |