<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>3.3.2 Connection objects </title> <META NAME="description" CONTENT="3.3.2 Connection objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <link rel="STYLESHEET" href="pyOpenSSL.css"> <LINK REL="previous" href="openssl-context.html"> <LINK REL="up" href="openssl-ssl.html"> <LINK REL="next" href="internals.html"> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="openssl-context.html"><img src="previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="openssl-ssl.html"><img src="up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="internals.html"><img src="next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python OpenSSL Manual</td> <td><A href="contents.html"><img src="contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><img src="blank.gif" border="0" height="32" alt="" width="32"></td> <td><img src="blank.gif" border="0" height="32" alt="" width="32"></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="openssl-context.html">3.3.1 Context objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A> <b class="navlabel">Next:</b> <a class="sectref" href="internals.html">4 Internals</A> <br><hr> </DIV> <!--End of Navigation Panel--> <H3><A NAME="SECTION000432000000000000000"> </A> <BR> 3.3.2 Connection objects </H3> <P> <EM><EM><EM>Connection objects have the following methods: </EM></EM></EM> <P> <dl><dt><b><a name='l2h-137'><tt class='method'>accept</tt></a></b>() <dd> Call the <tt class="method">accept</tt> method of the underlying socket and set up SSL on the returned socket, using the Context object supplied to this Connection object at creation. Returns a pair <code>(<var>conn</var>, <var>address</var>)</code>. where <var>conn</var> is the new Connection object created, and <var>address</var> is as returned by the socket's <tt class="method">accept</tt>. </dl> <P> <dl><dt><b><a name='l2h-138'><tt class='method'>bind</tt></a></b>(<var>address</var>) <dd> Call the <tt class="method">bind</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-139'><tt class='method'>close</tt></a></b>() <dd> Call the <tt class="method">close</tt> method of the underlying socket. Note: If you want correct SSL closure, you need to call the <tt class="method">shutdown</tt> method first. </dl> <P> <dl><dt><b><a name='l2h-140'><tt class='method'>connect</tt></a></b>(<var>address</var>) <dd> Call the <tt class="method">connect</tt> method of the underlying socket and set up SSL on the socket, using the Context object supplied to this Connection object at creation. </dl> <P> <dl><dt><b><a name='l2h-141'><tt class='method'>connect_ex</tt></a></b>(<var>address</var>) <dd> Call the <tt class="method">connect_ex</tt> method of the underlying socket and set up SSL on the socket, using the Context object supplied to this Connection object at creation. Note that if the <tt class="method">connect_ex</tt> method of the socket doesn't return 0, SSL won't be initialized. </dl> <P> <dl><dt><b><a name='l2h-142'><tt class='method'>do_handshake</tt></a></b>() <dd> Perform an SSL handshake (usually called after <tt class="method">renegotiate</tt> or one of <tt class="method">set_accept_state</tt> or <tt class="method">set_accept_state</tt>). This can raise the same exceptions as <tt class="method">send</tt> and <tt class="method">recv</tt>. </dl> <P> <dl><dt><b><a name='l2h-143'><tt class='method'>fileno</tt></a></b>() <dd> Retrieve the file descriptor number for the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-144'><tt class='method'>listen</tt></a></b>(<var>backlog</var>) <dd> Call the <tt class="method">listen</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-145'><tt class='method'>get_app_data</tt></a></b>() <dd> Retrieve application data as set by <tt class="method">set_app_data</tt>. </dl> <P> <dl><dt><b><a name='l2h-146'><tt class='method'>get_cipher_list</tt></a></b>() <dd> Retrieve the list of ciphers used by the Connection object. WARNING: This API has changed. It used to take an optional parameter and just return a string, but not it returns the entire list in one go. </dl> <P> <dl><dt><b><a name='l2h-147'><tt class='method'>get_context</tt></a></b>() <dd> Retrieve the Context object associated with this Connection. </dl> <P> <dl><dt><b><a name='l2h-148'><tt class='method'>get_peer_certificate</tt></a></b>() <dd> Retrieve the other side's certificate (if any) </dl> <P> <dl><dt><b><a name='l2h-149'><tt class='method'>getpeername</tt></a></b>() <dd> Call the <tt class="method">getpeername</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-150'><tt class='method'>getsockname</tt></a></b>() <dd> Call the <tt class="method">getsockname</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-151'><tt class='method'>getsockopt</tt></a></b>(<var>level, optname</var><big>[</big><var>, buflen</var><big>]</big>) <dd> Call the <tt class="method">getsockopt</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-152'><tt class='method'>pending</tt></a></b>() <dd> Retrieve the number of bytes that can be safely read from the SSL buffer. </dl> <P> <dl><dt><b><a name='l2h-153'><tt class='method'>recv</tt></a></b>(<var>bufsize</var>) <dd> Receive data from the Connection. The return value is a string representing the data received. The maximum amount of data to be received at once, is specified by <var>bufsize</var>. </dl> <P> <dl><dt><b><a name='l2h-154'><tt class='method'>renegotiate</tt></a></b>() <dd> Renegotiate the SSL session. Call this if you wish to change cipher suites or anything like that. </dl> <P> <dl><dt><b><a name='l2h-155'><tt class='method'>send</tt></a></b>(<var>string</var>) <dd> Send the <var>string</var> data to the Connection. </dl> <P> <dl><dt><b><a name='l2h-156'><tt class='method'>sendall</tt></a></b>(<var>string</var>) <dd> Send all of the <var>string</var> data to the Connection. This calls <tt class="method">send</tt> repeatedly until all data is sent. If an error occurs, it's impossible to tell how much data has been sent. </dl> <P> <dl><dt><b><a name='l2h-157'><tt class='method'>set_accept_state</tt></a></b>() <dd> Set the connection to work in server mode. The handshake will be handled automatically by read/write. </dl> <P> <dl><dt><b><a name='l2h-158'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>) <dd> Associate <var>data</var> with this Connection object. <var>data</var> can be retrieved later using the <tt class="method">get_app_data</tt> method. </dl> <P> <dl><dt><b><a name='l2h-159'><tt class='method'>set_connect_state</tt></a></b>() <dd> Set the connection to work in client mode. The handshake will be handled automatically by read/write. </dl> <P> <dl><dt><b><a name='l2h-160'><tt class='method'>setblocking</tt></a></b>(<var>flag</var>) <dd> Call the <tt class="method">setblocking</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-161'><tt class='method'>setsockopt</tt></a></b>(<var>level, optname, value</var>) <dd> Call the <tt class="method">setsockopt</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-162'><tt class='method'>shutdown</tt></a></b>() <dd> Send the shutdown message to the Connection. Returns true if the shutdown message exchange is completed and false otherwise (in which case you call <tt class="method">recv()</tt> or <tt class="method">send()</tt> when the connection becomes readable/writeable. </dl> <P> <dl><dt><b><a name='l2h-163'><tt class='method'>sock_shutdown</tt></a></b>(<var>how</var>) <dd> Call the <tt class="method">shutdown</tt> method of the underlying socket. </dl> <P> <dl><dt><b><a name='l2h-164'><tt class='method'>state_string</tt></a></b>() <dd> Retrieve a verbose string detailing the state of the Connection. </dl> <P> <dl><dt><b><a name='l2h-165'><tt class='method'>want_read</tt></a></b>() <dd> Checks if more data has to be read from the transport layer to complete an operation. </dl> <P> <dl><dt><b><a name='l2h-166'><tt class='method'>want_write</tt></a></b>() <dd> Checks if there is data to write to the transport layer to complete an operation. </dl> <P> <DIV CLASS="navigation"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="openssl-context.html"><img src="previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="openssl-ssl.html"><img src="up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="internals.html"><img src="next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python OpenSSL Manual</td> <td><A href="contents.html"><img src="contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><img src="blank.gif" border="0" height="32" alt="" width="32"></td> <td><img src="blank.gif" border="0" height="32" alt="" width="32"></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="openssl-context.html">3.3.1 Context objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A> <b class="navlabel">Next:</b> <a class="sectref" href="internals.html">4 Internals</A> <hr> <span class="release-info">Release 0.6.</span> </DIV> <!--End of Navigation Panel--> </BODY> </HTML>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
310ff2082c314df15b233393c190ee8b
>
files
>
18
