<!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.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>OpenOBEX: obex_ctrans_t 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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">OpenOBEX </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">obex_ctrans_t Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Function definition for custom transports. <a href="structobex__ctrans__t.html#details">More...</a></p> <p><code>#include <obex_const.h></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:a30afa9304ca8439c321d3dcbe1a02bd5"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#a30afa9304ca8439c321d3dcbe1a02bd5">connect</a> )(<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>)</td></tr> <tr class="memdesc:a30afa9304ca8439c321d3dcbe1a02bd5"><td class="mdescLeft"> </td><td class="mdescRight">connect to a server (client-only) <a href="#a30afa9304ca8439c321d3dcbe1a02bd5">More...</a><br /></td></tr> <tr class="separator:a30afa9304ca8439c321d3dcbe1a02bd5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5218bffae6687c40ef8010c05b6325cd"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#a5218bffae6687c40ef8010c05b6325cd">disconnect</a> )(<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>)</td></tr> <tr class="memdesc:a5218bffae6687c40ef8010c05b6325cd"><td class="mdescLeft"> </td><td class="mdescRight">disconnect (server/client) <a href="#a5218bffae6687c40ef8010c05b6325cd">More...</a><br /></td></tr> <tr class="separator:a5218bffae6687c40ef8010c05b6325cd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4e6ead1f5ec726a0fe85bfa047a21f5c"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#a4e6ead1f5ec726a0fe85bfa047a21f5c">listen</a> )(<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>)</td></tr> <tr class="memdesc:a4e6ead1f5ec726a0fe85bfa047a21f5c"><td class="mdescLeft"> </td><td class="mdescRight">listen to incoming connections (server-only) <a href="#a4e6ead1f5ec726a0fe85bfa047a21f5c">More...</a><br /></td></tr> <tr class="separator:a4e6ead1f5ec726a0fe85bfa047a21f5c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8236a04f969f10200a5cb97851342611"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#a8236a04f969f10200a5cb97851342611">read</a> )(<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>, uint8_t *buf, int size)</td></tr> <tr class="memdesc:a8236a04f969f10200a5cb97851342611"><td class="mdescLeft"> </td><td class="mdescRight">remote connection input This function is optional as it is an alternative to providing the data with <a class="el" href="api_8c.html#a24454492afd6272d033bc21fc103016e" title="Feed OBEX with data when using a custom transport. ">OBEX_CustomDataFeed()</a>. <a href="#a8236a04f969f10200a5cb97851342611">More...</a><br /></td></tr> <tr class="separator:a8236a04f969f10200a5cb97851342611"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abb35d52e030722e8342ad6d7e49bc1d8"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#abb35d52e030722e8342ad6d7e49bc1d8">write</a> )(<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>, uint8_t *buf, int len)</td></tr> <tr class="memdesc:abb35d52e030722e8342ad6d7e49bc1d8"><td class="mdescLeft"> </td><td class="mdescRight">remote connection output <a href="#abb35d52e030722e8342ad6d7e49bc1d8">More...</a><br /></td></tr> <tr class="separator:abb35d52e030722e8342ad6d7e49bc1d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2287d2764bec2cf7443f6f66f9f64f2c"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#a2287d2764bec2cf7443f6f66f9f64f2c">handleinput</a> )(<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>, int timeout)</td></tr> <tr class="memdesc:a2287d2764bec2cf7443f6f66f9f64f2c"><td class="mdescLeft"> </td><td class="mdescRight">directly called by <a class="el" href="obex_8h.html#ab662cf38ff64ca901ecc0d6431b93cc0" title="Let the OBEX parser do some work. ">OBEX_HandleInput</a> <a href="#a2287d2764bec2cf7443f6f66f9f64f2c">More...</a><br /></td></tr> <tr class="separator:a2287d2764bec2cf7443f6f66f9f64f2c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acb82b4588d4d8c3d8298d2028b6d72b3"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a></td></tr> <tr class="separator:acb82b4588d4d8c3d8298d2028b6d72b3"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Function definition for custom transports. </p> </div><h2 class="groupheader">Field Documentation</h2> <a id="a30afa9304ca8439c321d3dcbe1a02bd5"></a> <h2 class="memtitle"><span class="permalink"><a href="#a30afa9304ca8439c321d3dcbe1a02bd5">◆ </a></span>connect</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* obex_ctrans_t::connect) (<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>)</td> </tr> </table> </div><div class="memdoc"> <p>connect to a server (client-only) </p> </div> </div> <a id="acb82b4588d4d8c3d8298d2028b6d72b3"></a> <h2 class="memtitle"><span class="permalink"><a href="#acb82b4588d4d8c3d8298d2028b6d72b3">◆ </a></span>customdata</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* obex_ctrans_t::customdata</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="a5218bffae6687c40ef8010c05b6325cd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5218bffae6687c40ef8010c05b6325cd">◆ </a></span>disconnect</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* obex_ctrans_t::disconnect) (<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>)</td> </tr> </table> </div><div class="memdoc"> <p>disconnect (server/client) </p> </div> </div> <a id="a2287d2764bec2cf7443f6f66f9f64f2c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2287d2764bec2cf7443f6f66f9f64f2c">◆ </a></span>handleinput</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* obex_ctrans_t::handleinput) (<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>, int timeout)</td> </tr> </table> </div><div class="memdoc"> <p>directly called by <a class="el" href="obex_8h.html#ab662cf38ff64ca901ecc0d6431b93cc0" title="Let the OBEX parser do some work. ">OBEX_HandleInput</a> </p> </div> </div> <a id="a4e6ead1f5ec726a0fe85bfa047a21f5c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4e6ead1f5ec726a0fe85bfa047a21f5c">◆ </a></span>listen</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* obex_ctrans_t::listen) (<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>)</td> </tr> </table> </div><div class="memdoc"> <p>listen to incoming connections (server-only) </p> </div> </div> <a id="a8236a04f969f10200a5cb97851342611"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8236a04f969f10200a5cb97851342611">◆ </a></span>read</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* obex_ctrans_t::read) (<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>, uint8_t *buf, int size)</td> </tr> </table> </div><div class="memdoc"> <p>remote connection input This function is optional as it is an alternative to providing the data with <a class="el" href="api_8c.html#a24454492afd6272d033bc21fc103016e" title="Feed OBEX with data when using a custom transport. ">OBEX_CustomDataFeed()</a>. </p> <p>The memory that 'buf' points to has enough room for RX MTU bytes. The minimum number of bytes needed to go on is specified by 'size'. </p> </div> </div> <a id="abb35d52e030722e8342ad6d7e49bc1d8"></a> <h2 class="memtitle"><span class="permalink"><a href="#abb35d52e030722e8342ad6d7e49bc1d8">◆ </a></span>write</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* obex_ctrans_t::write) (<a class="el" href="obex_8h.html#a438ebf629aae07b785e3c1619912aaf8">obex_t</a> *handle, void *<a class="el" href="structobex__ctrans__t.html#acb82b4588d4d8c3d8298d2028b6d72b3">customdata</a>, uint8_t *buf, int len)</td> </tr> </table> </div><div class="memdoc"> <p>remote connection output </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="obex__const_8h.html">obex_const.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.14 </small></address> </body> </html>