<!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"/> <title>edelib: PTY Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">edelib  <span id="projectnumber">2.0.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.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><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</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>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a> </li> <li class="navelem"><a class="el" href="classedelib_1_1PTY.html">PTY</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">PTY Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="edelib::PTY" --> <p>emulate pty api <a href="classedelib_1_1PTY.html#details">More...</a></p> <p><code>#include <<a class="el" href="Pty_8h_source.html">edelib/Pty.h</a>></code></p> <p><a href="classedelib_1_1PTY-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1PTY.html#a2bb7624e617fcdda01e49ec31a783ba2">PTY</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1PTY.html#ab2c288b0c54db4acd1d0ea4674b8d205">~PTY</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1PTY.html#aa3312e0d6ddeadaefcd45dd055e9706f">getpt</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1PTY.html#aac50339f6f615fa2409adc0abca8f4c7">grantpt</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1PTY.html#ac7e3316e70ed9eb0ebe90f488d4684d6">unlockpt</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1PTY.html#a6778bf11c6adbc6d2c05e364d092a9e6">ptsname</a> ()</td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>emulate pty api </p> <p><a class="el" href="classedelib_1_1PTY.html" title="emulate pty api">PTY</a> compatibility routines. This class tries to emulate a UNIX98 <a class="el" href="classedelib_1_1PTY.html" title="emulate pty api">PTY</a> API on various platforms. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a2bb7624e617fcdda01e49ec31a783ba2"></a><!-- doxytag: member="edelib::PTY::PTY" ref="a2bb7624e617fcdda01e49ec31a783ba2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classedelib_1_1PTY.html">PTY</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a <a class="el" href="classedelib_1_1PTY.html" title="emulate pty api">PTY</a> object </p> </div> </div> <a class="anchor" id="ab2c288b0c54db4acd1d0ea4674b8d205"></a><!-- doxytag: member="edelib::PTY::~PTY" ref="ab2c288b0c54db4acd1d0ea4674b8d205" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">~<a class="el" href="classedelib_1_1PTY.html">PTY</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Destructs the object. The <a class="el" href="classedelib_1_1PTY.html" title="emulate pty api">PTY</a> is closed if it is still open </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa3312e0d6ddeadaefcd45dd055e9706f"></a><!-- doxytag: member="edelib::PTY::getpt" ref="aa3312e0d6ddeadaefcd45dd055e9706f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classedelib_1_1PTY.html#aa3312e0d6ddeadaefcd45dd055e9706f">getpt</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Allocate a pty </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A filedescriptor to the master side </dd></dl> </div> </div> <a class="anchor" id="aac50339f6f615fa2409adc0abca8f4c7"></a><!-- doxytag: member="edelib::PTY::grantpt" ref="aac50339f6f615fa2409adc0abca8f4c7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classedelib_1_1PTY.html#aac50339f6f615fa2409adc0abca8f4c7">grantpt</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Grant access to the slave side </p> <dl class="return"><dt><b>Returns:</b></dt><dd>zero if succesfull, < 0 otherwise </dd></dl> </div> </div> <a class="anchor" id="a6778bf11c6adbc6d2c05e364d092a9e6"></a><!-- doxytag: member="edelib::PTY::ptsname" ref="a6778bf11c6adbc6d2c05e364d092a9e6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classedelib_1_1PTY.html#a6778bf11c6adbc6d2c05e364d092a9e6">ptsname</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return the slave side name </p> </div> </div> <a class="anchor" id="ac7e3316e70ed9eb0ebe90f488d4684d6"></a><!-- doxytag: member="edelib::PTY::unlockpt" ref="ac7e3316e70ed9eb0ebe90f488d4684d6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classedelib_1_1PTY.html#ac7e3316e70ed9eb0ebe90f488d4684d6">unlockpt</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Unlock the pty. This allows connections on the slave side. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>Zero if successful, < 0 otherwise </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>edelib/<a class="el" href="Pty_8h_source.html">Pty.h</a></li> </ul> </div><!-- contents --> <hr class="footer"/><address class="footer"><small> Generated on Tue Jun 5 2012 17:49:03 for edelib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>