<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>DTN Reference Implementation: Subscriber.h Source File</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.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>Subscriber.h</h1><a href="Subscriber_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * Copyright 2007 Intel Corporation</span> <a name="l00003"></a>00003 <span class="comment"> * </span> <a name="l00004"></a>00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> <a name="l00005"></a>00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> <a name="l00006"></a>00006 <span class="comment"> * You may obtain a copy of the License at</span> <a name="l00007"></a>00007 <span class="comment"> * </span> <a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> <a name="l00009"></a>00009 <span class="comment"> * </span> <a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> <a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> <a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> <a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span> <a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span> <a name="l00015"></a>00015 <span class="comment"> */</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef _SUBSCRIBER_H_</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _SUBSCRIBER_H_</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include <vector></span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <span class="preprocessor">#include <oasys/debug/DebugUtils.h></span> <a name="l00023"></a>00023 <span class="preprocessor">#include <oasys/debug/Formatter.h></span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="EndpointID_8h.html">naming/EndpointID.h</a>"</span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="keyword">namespace </span>dtn { <a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="keyword">class </span>Registration; <a name="l00030"></a>00030 <a name="l00035"></a><a class="code" href="classdtn_1_1Subscriber.html">00035</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1Subscriber.html" title="A subscriber for a session is either a local registration or a next hop destination...">Subscriber</a> : <span class="keyword">public</span> oasys::<a class="code" href="classoasys_1_1Formatter.html">Formatter</a> { <a name="l00036"></a>00036 <span class="keyword">public</span>: <a name="l00038"></a><a class="code" href="classdtn_1_1Subscriber.html#ed4237ae1f8876b5c9ac024d8cc9ed79">00038</a> <a class="code" href="classdtn_1_1Subscriber.html#ed4237ae1f8876b5c9ac024d8cc9ed79" title="Constructor for a NULL subscriber (used for.">Subscriber</a>() <a name="l00039"></a>00039 : <a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a>(NULL), <a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">nexthop_</a>(<a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>::NULL_EID()) {} <a name="l00040"></a>00040 <a name="l00042"></a><a class="code" href="classdtn_1_1Subscriber.html#fd8d7751dee93cd0aec49d79bb881000">00042</a> <a class="code" href="classdtn_1_1Subscriber.html#ed4237ae1f8876b5c9ac024d8cc9ed79" title="Constructor for a NULL subscriber (used for.">Subscriber</a>(<a class="code" href="classdtn_1_1Registration.html" title="Class used to represent an &quot;application&quot; registration, loosely defined...">Registration</a>* <a class="code" href="classdtn_1_1Subscriber.html#ecca2a92bd69deb95163e3b8fae5dbba" title="Accessors.">reg</a>) <a name="l00043"></a>00043 : <a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a>(reg), <a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">nexthop_</a>(<a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>::NULL_EID()) {} <a name="l00044"></a>00044 <a name="l00046"></a><a class="code" href="classdtn_1_1Subscriber.html#4de98c56bc98d910a78f0deff324cf5f">00046</a> <a class="code" href="classdtn_1_1Subscriber.html#ed4237ae1f8876b5c9ac024d8cc9ed79" title="Constructor for a NULL subscriber (used for.">Subscriber</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& <a class="code" href="classdtn_1_1Subscriber.html#20132ad4ad9c22eb909f82a9a6a3fa72" title="Accessors.">nexthop</a>) <a name="l00047"></a>00047 : <a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a>(NULL), <a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">nexthop_</a>(nexthop) {} <a name="l00048"></a>00048 <a name="l00050"></a>00050 <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1Subscriber.html#943c641a515ca6963b7a298bb41ea776" title="Destructor.">~Subscriber</a>(); <a name="l00051"></a>00051 <a name="l00053"></a>00053 <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1Subscriber.html#1cb85ff7aeabe419a21493e74aff8203" title="Virtual from Formatter.">format</a>(<span class="keywordtype">char</span>* <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>, <span class="keywordtype">size_t</span> sz) <span class="keyword">const</span>; <a name="l00054"></a>00054 <a name="l00056"></a>00056 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1Subscriber.html#766065487b6b6d0e9fb786aa4c7bcc07" title="Comparison operator.">operator==</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1Subscriber.html" title="A subscriber for a session is either a local registration or a next hop destination...">Subscriber</a>& other) <span class="keyword">const</span>; <a name="l00057"></a>00057 <a name="l00059"></a>00059 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1Subscriber.html#cc20d7ea61447dcea8d8ee8852a6a015" title="Accessors.">is_null</a>() <span class="keyword">const</span>; <a name="l00060"></a><a class="code" href="classdtn_1_1Subscriber.html#d9105b34d6fcdb3397b402aebc4f7aef">00060</a> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1Subscriber.html#d9105b34d6fcdb3397b402aebc4f7aef" title="Accessors.">is_local</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a> != NULL; } <a name="l00061"></a><a class="code" href="classdtn_1_1Subscriber.html#ecca2a92bd69deb95163e3b8fae5dbba">00061</a> <a class="code" href="classdtn_1_1Registration.html" title="Class used to represent an &quot;application&quot; registration, loosely defined...">Registration</a>* <a class="code" href="classdtn_1_1Subscriber.html#ecca2a92bd69deb95163e3b8fae5dbba" title="Accessors.">reg</a>()<span class="keyword"> const </span>{ <a class="code" href="SDNV_8cc.html#ca68c0d4ac8df0838e209fb5300f7be3">ASSERT</a>(<a class="code" href="classdtn_1_1Subscriber.html#d9105b34d6fcdb3397b402aebc4f7aef" title="Accessors.">is_local</a>()); <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a>; } <a name="l00062"></a><a class="code" href="classdtn_1_1Subscriber.html#20132ad4ad9c22eb909f82a9a6a3fa72">00062</a> <span class="keyword">const</span> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& <a class="code" href="classdtn_1_1Subscriber.html#20132ad4ad9c22eb909f82a9a6a3fa72" title="Accessors.">nexthop</a>()<span class="keyword"> const </span>{ <a class="code" href="SDNV_8cc.html#ca68c0d4ac8df0838e209fb5300f7be3">ASSERT</a>(!<a class="code" href="classdtn_1_1Subscriber.html#d9105b34d6fcdb3397b402aebc4f7aef" title="Accessors.">is_local</a>()); <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">nexthop_</a>; } <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="keyword">protected</span>: <a name="l00066"></a><a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">00066</a> <a class="code" href="classdtn_1_1Registration.html" title="Class used to represent an &quot;application&quot; registration, loosely defined...">Registration</a>* <a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a>; <a name="l00067"></a><a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">00067</a> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a> <a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">nexthop_</a>; <a name="l00068"></a>00068 }; <a name="l00069"></a>00069 <a name="l00070"></a>00070 <span class="comment">//----------------------------------------------------------------------</span> <a name="l00071"></a>00071 <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a name="l00072"></a><a class="code" href="classdtn_1_1Subscriber.html#cc20d7ea61447dcea8d8ee8852a6a015">00072</a> <a class="code" href="classdtn_1_1Subscriber.html#cc20d7ea61447dcea8d8ee8852a6a015" title="Accessors.">Subscriber::is_null</a>()<span class="keyword"> const</span> <a name="l00073"></a>00073 <span class="keyword"></span>{ <a name="l00074"></a>00074 <span class="keywordflow">return</span> (<a class="code" href="classdtn_1_1Subscriber.html#0a93350a229c7ffdb75f2f16a60b7d16">reg_</a> == NULL && <a class="code" href="classdtn_1_1Subscriber.html#3655c0a8ad0c27d40318946a0557a17e">nexthop_</a> == <a class="code" href="classdtn_1_1EndpointID.html#31bd1844cae5e71cc2393a139c9bec4c" title="Return the special endpoint id used for the null endpoint, namely &quot;dtn:none&quot;...">EndpointID::NULL_EID</a>()); <a name="l00075"></a>00075 } <a name="l00076"></a>00076 <a name="l00080"></a><a class="code" href="namespacedtn.html#c04549597621019784854bfdb66463d3">00080</a> <span class="keyword">typedef</span> std::vector<Subscriber> <a class="code" href="namespacedtn.html#c04549597621019784854bfdb66463d3" title="Type for a vector of subscriber objects.">SubscriberList</a>; <a name="l00081"></a>00081 <a name="l00082"></a>00082 } <span class="comment">// namespace dtn</span> <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="preprocessor">#endif </span><span class="comment">/* _SUBSCRIBER_H_ */</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:47 2008 for DTN Reference Implementation by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>