<!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: Session.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<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>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>Session.h</h1><a href="Session_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 _SESSION_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _SESSION_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <oasys/debug/Formatter.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <oasys/debug/Logger.h></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="Subscriber_8h.html">Subscriber.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="bundling_2BundleList_8h.html">bundling/BundleList.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="SequenceID_8h.html">bundling/SequenceID.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="EndpointID_8h.html">naming/EndpointID.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="RouteEntry_8h.html">routing/RouteEntry.h</a>"</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>oasys {
<a name="l00030"></a>00030 <span class="keyword">class </span>Timer;
<a name="l00031"></a>00031 }
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>dtn {
<a name="l00034"></a>00034
<a name="l00038"></a><a class="code" href="classdtn_1_1Session.html">00038</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1Session.html" title="Class to manage a session.">Session</a> : <span class="keyword">public</span> oasys::<a class="code" href="classoasys_1_1Formatter.html">Formatter</a>,
<a name="l00039"></a>00039 <span class="keyword">public</span> oasys::<a class="code" href="classoasys_1_1Logger.html">Logger</a>,
<a name="l00040"></a>00040 <span class="keyword">public</span> <a class="code" href="classdtn_1_1RouteEntryInfo.html" title="Interface for any per-entry routing algorithm state.">RouteEntryInfo</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00043"></a>00043 <span class="keyword">class </span>ResubscribeTimer;
<a name="l00044"></a>00044
<a name="l00049"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c">00049</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00050"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498cfb01c7fbba0e5924bad579f9ff6f821e">00050</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498cfb01c7fbba0e5924bad579f9ff6f821e">NONE</a> = 0,
<a name="l00051"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498cadd5836fef35cca7c207e710e8e13239">00051</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498cadd5836fef35cca7c207e710e8e13239">SUBSCRIBE</a> = 1<<1,
<a name="l00052"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c8ec080183d9e900330780466c77a30be">00052</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c8ec080183d9e900330780466c77a30be">RESUBSCRIBE</a> = 1<<2,
<a name="l00053"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c8e488d456de6b606d948dde9283e7c67">00053</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c8e488d456de6b606d948dde9283e7c67">UNSUBSCRIBE</a> = 1<<3,
<a name="l00054"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498ccdf11ed3fd8ed094c39a59734bdc4822">00054</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498ccdf11ed3fd8ed094c39a59734bdc4822">SUBSCRIPTION_ACK</a> = 1<<4,
<a name="l00055"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c1978e38ca305c80fe009dd50fe24a3be">00055</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c1978e38ca305c80fe009dd50fe24a3be">PUBLISH</a> = 1<<5,
<a name="l00056"></a><a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c1ccfadd042afba693bbcf1e5980667d9">00056</a> <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c1ccfadd042afba693bbcf1e5980667d9">CUSTODY</a> = 1<<6
<a name="l00057"></a>00057 } <a class="code" href="classdtn_1_1Session.html#a795473f389a203d6e15058da8d9498c" title="Type for session-related flags.">flags_t</a>;
<a name="l00058"></a>00058
<a name="l00062"></a>00062 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classdtn_1_1Session.html#f8421d3cc745b485e316195af331fe37" title="Pretty print function for session flags.">flag_str</a>(u_int flags);
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <a class="code" href="classdtn_1_1Session.html#fe6268c4ee6a16422b353a4c1b4d5664">Session</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& <a class="code" href="classdtn_1_1Session.html#66224a2445e558bacc56d3977909a6d1">eid</a>);
<a name="l00065"></a>00065 <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1Session.html#5e21c3d507e14646639cf10bde0ecd85">~Session</a>();
<a name="l00066"></a>00066
<a name="l00068"></a>00068 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1Session.html#96dc0cfc6d7733784b250e7ed3a47476" 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="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Session.html#4226535ee200c42854fb5fd040134dbd">set_upstream</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>& subscriber);
<a name="l00071"></a>00071 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Session.html#92b88bd55939a1766a3f2674ce20482c">add_subscriber</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>& subscriber);
<a name="l00072"></a><a class="code" href="classdtn_1_1Session.html#30bf27ca931dcd41de355a51b2c47c8d">00072</a> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Session.html#30bf27ca931dcd41de355a51b2c47c8d">set_resubscribe_timer</a>(oasys::Timer* t) { <a class="code" href="classdtn_1_1Session.html#74beee01234ac9ebdddd53d0fdcc0559" title="Timer to re-send subscribe message.">resubscribe_timer_</a> = t; }
<a name="l00073"></a>00073
<a name="l00074"></a><a class="code" href="classdtn_1_1Session.html#6844cf754501357d8e0be0709e719cec">00074</a> u_int32_t <a class="code" href="classdtn_1_1Session.html#6844cf754501357d8e0be0709e719cec">id</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Session.html#194a1eafb5c14dea66cd7dcd33be2b82" title="Unique session id (for logging).">id_</a>; }
<a name="l00075"></a><a class="code" href="classdtn_1_1Session.html#66224a2445e558bacc56d3977909a6d1">00075</a> <span class="keyword">const</span> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& <a class="code" href="classdtn_1_1Session.html#66224a2445e558bacc56d3977909a6d1">eid</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Session.html#30b1d2db517a7bb230331c9c32f11c46" title="EndpointID naming the session.">eid_</a>;}
<a name="l00076"></a><a class="code" href="classdtn_1_1Session.html#d483d580e9a1e213e974cb41b875065b">00076</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>& <a class="code" href="classdtn_1_1Session.html#d483d580e9a1e213e974cb41b875065b">upstream</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Session.html#807018061f8e844a2e813dcb7908fbb7" title="Subscriber in direction of a custodian.">upstream_</a>; }
<a name="l00077"></a><a class="code" href="classdtn_1_1Session.html#f06e7f94d2ed1aeda7dafe18a2dd747e">00077</a> <span class="keyword">const</span> <a class="code" href="namespacedtn.html#c04549597621019784854bfdb66463d3" title="Type for a vector of subscriber objects.">SubscriberList</a>& <a class="code" href="classdtn_1_1Session.html#f06e7f94d2ed1aeda7dafe18a2dd747e">subscribers</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Session.html#eaf2b2040e890ac4668c13095f6f06ad" title="Local + downstream subscribers.">subscribers_</a>; }
<a name="l00078"></a><a class="code" href="classdtn_1_1Session.html#21163251275fc2104de91c66fd9543d8">00078</a> <a class="code" href="classdtn_1_1BundleList.html" title="List structure for handling bundles.">BundleList</a>* <a class="code" href="classdtn_1_1Session.html#21163251275fc2104de91c66fd9543d8">bundles</a>() { <span class="keywordflow">return</span> &<a class="code" href="classdtn_1_1Session.html#caf06d8eb71d2c3623bf5d4727694da9" title="Currently-resident session bundles.">bundles_</a>; }
<a name="l00079"></a><a class="code" href="classdtn_1_1Session.html#bd799ea58a766a69bcfadf0f1ddef47f">00079</a> <a class="code" href="classdtn_1_1SequenceID.html" title="A bundle SequenceID is a version vector of (EID, counter) and/or (EID, identifier)...">SequenceID</a>* <a class="code" href="classdtn_1_1Session.html#bd799ea58a766a69bcfadf0f1ddef47f">sequence_id</a>() { <span class="keywordflow">return</span> &<a class="code" href="classdtn_1_1Session.html#9843de45bc84eef1b92979370c51f071" title="SequenceID that covers all bundles.">sequence_id_</a>; }
<a name="l00080"></a><a class="code" href="classdtn_1_1Session.html#5bb0b08cf18c10775cf5e40b3d6181a6">00080</a> oasys::Timer* <a class="code" href="classdtn_1_1Session.html#5bb0b08cf18c10775cf5e40b3d6181a6">resubscribe_timer</a>() { <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Session.html#74beee01234ac9ebdddd53d0fdcc0559" title="Timer to re-send subscribe message.">resubscribe_timer_</a>; }
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">protected</span>:
<a name="l00083"></a><a class="code" href="classdtn_1_1Session.html#194a1eafb5c14dea66cd7dcd33be2b82">00083</a> u_int32_t <a class="code" href="classdtn_1_1Session.html#194a1eafb5c14dea66cd7dcd33be2b82" title="Unique session id (for logging).">id_</a>;
<a name="l00084"></a><a class="code" href="classdtn_1_1Session.html#30b1d2db517a7bb230331c9c32f11c46">00084</a> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a> <a class="code" href="classdtn_1_1Session.html#30b1d2db517a7bb230331c9c32f11c46" title="EndpointID naming the session.">eid_</a>;
<a name="l00085"></a><a class="code" href="classdtn_1_1Session.html#807018061f8e844a2e813dcb7908fbb7">00085</a> <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> <a class="code" href="classdtn_1_1Session.html#807018061f8e844a2e813dcb7908fbb7" title="Subscriber in direction of a custodian.">upstream_</a>;
<a name="l00086"></a><a class="code" href="classdtn_1_1Session.html#eaf2b2040e890ac4668c13095f6f06ad">00086</a> <a class="code" href="namespacedtn.html#c04549597621019784854bfdb66463d3" title="Type for a vector of subscriber objects.">SubscriberList</a> <a class="code" href="classdtn_1_1Session.html#eaf2b2040e890ac4668c13095f6f06ad" title="Local + downstream subscribers.">subscribers_</a>;
<a name="l00087"></a><a class="code" href="classdtn_1_1Session.html#caf06d8eb71d2c3623bf5d4727694da9">00087</a> <a class="code" href="classdtn_1_1BundleList.html" title="List structure for handling bundles.">BundleList</a> <a class="code" href="classdtn_1_1Session.html#caf06d8eb71d2c3623bf5d4727694da9" title="Currently-resident session bundles.">bundles_</a>;
<a name="l00088"></a><a class="code" href="classdtn_1_1Session.html#9843de45bc84eef1b92979370c51f071">00088</a> <a class="code" href="classdtn_1_1SequenceID.html" title="A bundle SequenceID is a version vector of (EID, counter) and/or (EID, identifier)...">SequenceID</a> <a class="code" href="classdtn_1_1Session.html#9843de45bc84eef1b92979370c51f071" title="SequenceID that covers all bundles.">sequence_id_</a>;
<a name="l00089"></a><a class="code" href="classdtn_1_1Session.html#74beee01234ac9ebdddd53d0fdcc0559">00089</a> oasys::Timer* <a class="code" href="classdtn_1_1Session.html#74beee01234ac9ebdddd53d0fdcc0559" title="Timer to re-send subscribe message.">resubscribe_timer_</a>;
<a name="l00090"></a>00090 };
<a name="l00091"></a>00091
<a name="l00092"></a>00092 } <span class="comment">// namespace dtn</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="preprocessor">#endif </span><span class="comment">/* _SESSION_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:26:58 2009 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.8 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
29c369053a983cc5d8c880dc6e0a2237
>
files
>
636
