CustodySignal.h

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  *
00007  * Intel Open Source License
00008  *
00009  * 2006 Intel Corporation. All rights reserved.
00010  *
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  *
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  *
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  *
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 #ifndef _CUSTODYSIGNAL_H_
00039 #define _CUSTODYSIGNAL_H_
00040 
00041 #include "Bundle.h"
00042 #include "BundleProtocol.h"
00043 
00044 namespace dtn {
00045 
00049 class CustodySignal {
00050 public:
00054     typedef BundleProtocol::custody_signal_reason_t reason_t;
00055 
00059     struct data_t {
00060         u_int8_t        admin_type_;
00061         u_int8_t        admin_flags_;
00062         bool            succeeded_;
00063         u_int8_t        reason_;
00064         u_int64_t       orig_frag_offset_;
00065         u_int64_t       orig_frag_length_;
00066         BundleTimestamp custody_signal_tv_;
00067         BundleTimestamp orig_creation_tv_;
00068         EndpointID      orig_source_eid_;
00069     };
00070 
00074     static void create_custody_signal(Bundle*           bundle,
00075                                       const Bundle*     orig_bundle,
00076                                       const EndpointID& source_eid,
00077                                       bool              succeeded,
00078                                       reason_t          reason);
00079 
00083     static bool parse_custody_signal(data_t* data,
00084                                      const u_char* bp, u_int len);
00085 
00089     static const char* reason_to_str(u_int8_t reason);
00090 };
00091 
00092 } // namespace dtn
00093 
00094 #endif /* _CUSTODYSIGNAL_H_ */

Generated on Fri Dec 22 14:47:58 2006 for DTN Reference Implementation by  doxygen 1.5.1