<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>scim: scim::SocketAddress Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
<ul>
<li><a href="main.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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<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 class="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00105.html">SocketAddress</a></div>
<h1>scim::SocketAddress Class Reference<br>
<small>
[<a class="el" href="a00165.html">SocketCommunication</a>]</small>
</h1><!-- doxytag: class="scim::SocketAddress" -->The class to hold a socket address.
<a href="#_details">More...</a>
<p>
<code>#include <scim_socket.h></code>
<p>
<a href="a00656.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#9584c7c3f4c52fcdae9d1d39e3c41156">SocketAddress</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &addr=<a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#9584c7c3f4c52fcdae9d1d39e3c41156"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#27142eebf8ddf728cbab642581eed0d7">SocketAddress</a> (const <a class="el" href="a00105.html">SocketAddress</a> &addr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#27142eebf8ddf728cbab642581eed0d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#2cf7bb56ed00c2e0e6baebaa783b6bb5">~SocketAddress</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#2cf7bb56ed00c2e0e6baebaa783b6bb5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="a00105.html">SocketAddress</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#e86cacdff5f902eb76712304982e39fc">operator=</a> (const <a class="el" href="a00105.html">SocketAddress</a> &addr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy operator. <a href="#e86cacdff5f902eb76712304982e39fc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#dbd53c658f05f1d59657755571a08c6f">valid</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if this address is valid. <a href="#dbd53c658f05f1d59657755571a08c6f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00165.html#gcc123ee748d644961e203b0794004254">SocketFamily</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#811baaa16f247e8664ff51541ab58522">get_family</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the family of this socket address. <a href="#811baaa16f247e8664ff51541ab58522"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#884e26503d63a7af69a38edcf09560e2">set_address</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &addr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a new address. <a href="#884e26503d63a7af69a38edcf09560e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#d6e452cf01c5a1aef9385e0ab2a2f724">get_address</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the address string. <a href="#d6e452cf01c5a1aef9385e0ab2a2f724"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#acfa306e7c6005459f6398806145ec04">get_data</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the internal data of this socket address, used by class <a class="el" href="a00104.html">Socket</a>. <a href="#acfa306e7c6005459f6398806145ec04"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a7a0cbe3ab5b05dd29b6679beb98951d">get_data_length</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the internall data. <a href="#a7a0cbe3ab5b05dd29b6679beb98951d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The class to hold a socket address.
<p>
Class <a class="el" href="a00105.html">SocketAddress</a> encapsulates the details of socket address, like socketaddr_un and socketaddr_in.<p>
A <a class="el" href="a00105.html">SocketAddress</a> object can be constructed from an address string, which must start with one of the following prefixes:<ul>
<li>inet: or tcp: A internet address (ipv4). This kind of address must include two parts, separated by a colon. The first part is the ip address, the second part is the port. For example: inet:127.0.0.1:12345</li><li>local: or unix: or file: A unix or local socket address. It's a full path of a socket file. For example: local:/tmp/scim-socket-frontend </li></ul>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9584c7c3f4c52fcdae9d1d39e3c41156"></a><!-- doxytag: member="scim::SocketAddress::SocketAddress" ref="9584c7c3f4c52fcdae9d1d39e3c41156" args="(const String &addr=String())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::SocketAddress::SocketAddress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>addr</em> = <code><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>()</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>the address string. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="27142eebf8ddf728cbab642581eed0d7"></a><!-- doxytag: member="scim::SocketAddress::SocketAddress" ref="27142eebf8ddf728cbab642581eed0d7" args="(const SocketAddress &addr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::SocketAddress::SocketAddress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00105.html">SocketAddress</a> & </td>
<td class="paramname"> <em>addr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
</div>
</div><p>
<a class="anchor" name="2cf7bb56ed00c2e0e6baebaa783b6bb5"></a><!-- doxytag: member="scim::SocketAddress::~SocketAddress" ref="2cf7bb56ed00c2e0e6baebaa783b6bb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::SocketAddress::~SocketAddress </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e86cacdff5f902eb76712304982e39fc"></a><!-- doxytag: member="scim::SocketAddress::operator=" ref="e86cacdff5f902eb76712304982e39fc" args="(const SocketAddress &addr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00105.html">SocketAddress</a>& scim::SocketAddress::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00105.html">SocketAddress</a> & </td>
<td class="paramname"> <em>addr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy operator.
<p>
</div>
</div><p>
<a class="anchor" name="dbd53c658f05f1d59657755571a08c6f"></a><!-- doxytag: member="scim::SocketAddress::valid" ref="dbd53c658f05f1d59657755571a08c6f" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::SocketAddress::valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this address is valid.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if this address is valid. </dd></dl>
</div>
</div><p>
<a class="anchor" name="811baaa16f247e8664ff51541ab58522"></a><!-- doxytag: member="scim::SocketAddress::get_family" ref="811baaa16f247e8664ff51541ab58522" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00165.html#gcc123ee748d644961e203b0794004254">SocketFamily</a> scim::SocketAddress::get_family </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the family of this socket address.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the family enum value of this address.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00165.html#gcc123ee748d644961e203b0794004254">SocketFamily</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="884e26503d63a7af69a38edcf09560e2"></a><!-- doxytag: member="scim::SocketAddress::set_address" ref="884e26503d63a7af69a38edcf09560e2" args="(const String &addr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::SocketAddress::set_address </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>addr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a new address.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>the new address string. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d6e452cf01c5a1aef9385e0ab2a2f724"></a><!-- doxytag: member="scim::SocketAddress::get_address" ref="d6e452cf01c5a1aef9385e0ab2a2f724" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::SocketAddress::get_address </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the address string.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the address string. </dd></dl>
</div>
</div><p>
<a class="anchor" name="acfa306e7c6005459f6398806145ec04"></a><!-- doxytag: member="scim::SocketAddress::get_data" ref="acfa306e7c6005459f6398806145ec04" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* scim::SocketAddress::get_data </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the internal data of this socket address, used by class <a class="el" href="a00104.html">Socket</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the pointer to the data, usually a sockaddr struct. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a7a0cbe3ab5b05dd29b6679beb98951d"></a><!-- doxytag: member="scim::SocketAddress::get_data_length" ref="a7a0cbe3ab5b05dd29b6679beb98951d" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::SocketAddress::get_data_length </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the size of the internall data.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the size of the internall data returned by get_data (); </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00151.html">scim_socket.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:52 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
