<!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"/>
<title>Apache log4cxx: DatagramSocket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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="classes.html"><span>Class Index</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1helpers_1_1_datagram_socket.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>DatagramSocket Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::DatagramSocket" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>This class represents a socket for sending and receiving datagram packets.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_datagram_socket-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="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a9674f42acc9ca978657e16c7705ad512">DatagramSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a datagram socket and binds it to any available port on the local host machine. <a href="#a9674f42acc9ca978657e16c7705ad512"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a3178a740b31d5714f5cd7ddf57e3790f">DatagramSocket</a> (int port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a datagram socket and binds it to the specified port on the local host machine. <a href="#a3178a740b31d5714f5cd7ddf57e3790f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#af37b8130567b0ef3cc33d3afa34b4d27">DatagramSocket</a> (int port, InetAddressPtr laddr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a datagram socket, bound to the specified local address. <a href="#af37b8130567b0ef3cc33d3afa34b4d27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a725c161829aa03b1b45a8f5b2033e99d">~DatagramSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ensure the socket is closed. <a href="#a725c161829aa03b1b45a8f5b2033e99d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#ade2413bd001ffecc2852fd7ade204464">bind</a> (int lport, InetAddressPtr laddress)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a datagram socket to a local port and address. <a href="#ade2413bd001ffecc2852fd7ade204464"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#ae2ee59f7cc16ee42559c87e81c433039">create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a datagram socket. <a href="#ae2ee59f7cc16ee42559c87e81c433039"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes this datagram socket. <a href="#a5ae591df94fc66ccb85cbb6565368bca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a2dd0c43994e511e154b88540f2d1e598">connect</a> (InetAddressPtr address, int port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects the socket to a remote address for this socket. <a href="#a2dd0c43994e511e154b88540f2d1e598"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">InetAddressPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#abbfdb429dc48519dec0010ffeced144a">getInetAddress</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the address to which this socket is connected. <a href="#abbfdb429dc48519dec0010ffeced144a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">InetAddressPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a2d91f24e2f7e5fd93c6faf09ed51a3ed">getLocalAddress</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the local address to which the socket is bound. <a href="#a2d91f24e2f7e5fd93c6faf09ed51a3ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#af603b5a027ae0fb598e0abd0ba11994c">getLocalPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the port number on the local host to which this socket is bound. <a href="#af603b5a027ae0fb598e0abd0ba11994c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a5e4fc3488ccbe0511b7e7a1b3ca873cf">getPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the port for this socket. <a href="#a5e4fc3488ccbe0511b7e7a1b3ca873cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a3b29f170eb389b769be3eeb459c7c9ea">isBound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the binding state of the socket. <a href="#a3b29f170eb389b769be3eeb459c7c9ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#aede4b7e16e8732d29bb13b8fe77573b7">isClosed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns wether the socket is closed or not. <a href="#aede4b7e16e8732d29bb13b8fe77573b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#a180fa55a4bf36580963bed9e3e09c227">isConnected</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the connection state of the socket. <a href="#a180fa55a4bf36580963bed9e3e09c227"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#afc5ae26084eeee0232326fa48855382e">receive</a> (DatagramPacketPtr &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receives a datagram packet from this socket. <a href="#afc5ae26084eeee0232326fa48855382e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html#ac46c8224e4a41eb6269639e0e726d48d">send</a> (DatagramPacketPtr &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a datagram packet from this socket. <a href="#ac46c8224e4a41eb6269639e0e726d48d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class represents a socket for sending and receiving datagram packets. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9674f42acc9ca978657e16c7705ad512"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::DatagramSocket" ref="a9674f42acc9ca978657e16c7705ad512" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html">DatagramSocket</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a datagram socket and binds it to any available port on the local host machine. </p>
</div>
</div>
<a class="anchor" id="a3178a740b31d5714f5cd7ddf57e3790f"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::DatagramSocket" ref="a3178a740b31d5714f5cd7ddf57e3790f" args="(int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html">DatagramSocket</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a datagram socket and binds it to the specified port on the local host machine. </p>
</div>
</div>
<a class="anchor" id="af37b8130567b0ef3cc33d3afa34b4d27"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::DatagramSocket" ref="af37b8130567b0ef3cc33d3afa34b4d27" args="(int port, InetAddressPtr laddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html">DatagramSocket</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InetAddressPtr </td>
<td class="paramname"><em>laddr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a datagram socket, bound to the specified local address. </p>
</div>
</div>
<a class="anchor" id="a725c161829aa03b1b45a8f5b2033e99d"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::~DatagramSocket" ref="a725c161829aa03b1b45a8f5b2033e99d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html">DatagramSocket</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ensure the socket is closed. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ade2413bd001ffecc2852fd7ade204464"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::bind" ref="ade2413bd001ffecc2852fd7ade204464" args="(int lport, InetAddressPtr laddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bind </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>lport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InetAddressPtr </td>
<td class="paramname"><em>laddress</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a datagram socket to a local port and address. </p>
</div>
</div>
<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::close" ref="a5ae591df94fc66ccb85cbb6565368bca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes this datagram socket. </p>
</div>
</div>
<a class="anchor" id="a2dd0c43994e511e154b88540f2d1e598"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::connect" ref="a2dd0c43994e511e154b88540f2d1e598" args="(InetAddressPtr address, int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void connect </td>
<td>(</td>
<td class="paramtype">InetAddressPtr </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects the socket to a remote address for this socket. </p>
</div>
</div>
<a class="anchor" id="ae2ee59f7cc16ee42559c87e81c433039"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::create" ref="ae2ee59f7cc16ee42559c87e81c433039" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a datagram socket. </p>
</div>
</div>
<a class="anchor" id="abbfdb429dc48519dec0010ffeced144a"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::getInetAddress" ref="abbfdb429dc48519dec0010ffeced144a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InetAddressPtr getInetAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the address to which this socket is connected. </p>
</div>
</div>
<a class="anchor" id="a2d91f24e2f7e5fd93c6faf09ed51a3ed"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::getLocalAddress" ref="a2d91f24e2f7e5fd93c6faf09ed51a3ed" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InetAddressPtr getLocalAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the local address to which the socket is bound. </p>
</div>
</div>
<a class="anchor" id="af603b5a027ae0fb598e0abd0ba11994c"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::getLocalPort" ref="af603b5a027ae0fb598e0abd0ba11994c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getLocalPort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the port number on the local host to which this socket is bound. </p>
</div>
</div>
<a class="anchor" id="a5e4fc3488ccbe0511b7e7a1b3ca873cf"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::getPort" ref="a5e4fc3488ccbe0511b7e7a1b3ca873cf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getPort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the port for this socket. </p>
</div>
</div>
<a class="anchor" id="a3b29f170eb389b769be3eeb459c7c9ea"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::isBound" ref="a3b29f170eb389b769be3eeb459c7c9ea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isBound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the binding state of the socket. </p>
</div>
</div>
<a class="anchor" id="aede4b7e16e8732d29bb13b8fe77573b7"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::isClosed" ref="aede4b7e16e8732d29bb13b8fe77573b7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isClosed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns wether the socket is closed or not. </p>
</div>
</div>
<a class="anchor" id="a180fa55a4bf36580963bed9e3e09c227"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::isConnected" ref="a180fa55a4bf36580963bed9e3e09c227" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isConnected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the connection state of the socket. </p>
</div>
</div>
<a class="anchor" id="afc5ae26084eeee0232326fa48855382e"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::receive" ref="afc5ae26084eeee0232326fa48855382e" args="(DatagramPacketPtr &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void receive </td>
<td>(</td>
<td class="paramtype">DatagramPacketPtr & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives a datagram packet from this socket. </p>
</div>
</div>
<a class="anchor" id="ac46c8224e4a41eb6269639e0e726d48d"></a><!-- doxytag: member="log4cxx::helpers::DatagramSocket::send" ref="ac46c8224e4a41eb6269639e0e726d48d" args="(DatagramPacketPtr &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void send </td>
<td>(</td>
<td class="paramtype">DatagramPacketPtr & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends a datagram packet from this socket. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="datagramsocket_8h.html">datagramsocket.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1helpers.html">helpers</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1helpers_1_1_datagram_socket.html">DatagramSocket</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
