senf/Socket/FileHandle.cci

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief FileHandle inline non-template implementation
  30  */
  31
  32 //#include "FileHandle.ih"
  33
  34 // Custom includes
  35 #include <senf/Utils/senfassert.hh>
  36 #include <errno.h>
  37
  38 #define prefix_ inline
  39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  40
  41 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  42 // senf::FileBody
  43
  44 prefix_ senf::FileBody::FileBody(int fd)
  45     : fd_(fd)
  46 {}
  47
  48 prefix_ senf::FileHandle senf::FileBody::handle()
  49 {
  50     return FileHandle(ptr(this));
  51 }
  52
  53 prefix_ int senf::FileBody::fd()
  54     const
  55 {
  56     return fd_;
  57 }
  58
  59 prefix_ void senf::FileBody::fd(int fd)
  60 {
  61     fd_ = fd;
  62 }
  63
  64 prefix_ bool senf::FileBody::eof()
  65     const
  66 {
  67     return v_eof();
  68 }
  69
  70 prefix_ bool senf::FileBody::valid()
  71     const
  72 {
  73     return fd_!=-1 && v_valid();
  74 }
  75
  76 prefix_ bool senf::FileBody::readable()
  77     const
  78 {
  79     return pollCheck(fd(),true,0);
  80 }
  81
  82 prefix_ bool senf::FileBody::waitReadable(senf::ClockService::clock_type timeout)
  83     const
  84 {
  85     return pollCheck(fd(), true,
  86                      (timeout==-1?-1:senf::ClockService::in_milliseconds(timeout)) );
  87 }
  88
  89 prefix_ bool senf::FileBody::writeable()
  90     const
  91 {
  92     return pollCheck(fd(),false,0);
  93 }
  94
  95 prefix_ bool senf::FileBody::waitWriteable(senf::ClockService::clock_type timeout)
  96     const
  97 {
  98     return pollCheck(fd(), false,
  99                      (timeout==-1?-1:senf::ClockService::in_milliseconds(timeout)) );
 100 }
 101
 102 prefix_ bool senf::FileBody::oobReadable()
 103     const
 104 {
 105     return pollCheck(fd(),true,0,true);
 106 }
 107
 108 prefix_ bool senf::FileBody::waitOOBReadable(senf::ClockService::clock_type timeout)
 109     const
 110 {
 111     return pollCheck(fd(), true,
 112                      (timeout==-1?-1:senf::ClockService::in_milliseconds(timeout)), true);
 113 }
 114
 115 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 116 // senf::FileHandle
 117
 118 prefix_ senf::FileBody & senf::FileHandle::body()
 119 {
 120     SENF_ASSERT(body_, "dereferencing in-valid() FileHandle");
 121     return *body_;
 122 }
 123
 124 prefix_ senf::FileBody const & senf::FileHandle::body()
 125     const
 126 {
 127     SENF_ASSERT(body_, "dereferencing in-valid() FileHandle");
 128     return *body_;
 129 }
 130
 131 prefix_ void senf::FileHandle::close()
 132 {
 133     body().close();
 134 }
 135
 136 prefix_ void senf::FileHandle::terminate()
 137 {
 138     body().terminate();
 139 }
 140
 141 prefix_ bool senf::FileHandle::readable()
 142     const
 143 {
 144     return body().readable();
 145 }
 146
 147 prefix_ bool senf::FileHandle::waitReadable(senf::ClockService::clock_type timeout)
 148     const
 149 {
 150     return body().waitReadable(timeout);
 151 }
 152
 153 prefix_ bool senf::FileHandle::writeable()
 154     const
 155 {
 156     return body().writeable();
 157 }
 158
 159 prefix_ bool senf::FileHandle::waitWriteable(senf::ClockService::clock_type timeout)
 160     const
 161 {
 162     return body().waitWriteable(timeout);
 163 }
 164
 165 prefix_ bool senf::FileHandle::oobReadable()
 166     const
 167 {
 168     return body().oobReadable();
 169 }
 170
 171 prefix_ bool senf::FileHandle::waitOOBReadable(senf::ClockService::clock_type timeout)
 172     const
 173 {
 174     return body().waitOOBReadable(timeout);
 175 }
 176
 177 prefix_ bool senf::FileHandle::blocking()
 178     const
 179 {
 180     return body().blocking();
 181 }
 182
 183 prefix_ void senf::FileHandle::blocking(bool status)
 184 {
 185     body().blocking(status);
 186 }
 187
 188 prefix_ bool senf::FileHandle::eof()
 189     const
 190 {
 191     return body().eof();
 192 }
 193
 194 prefix_ bool senf::FileHandle::valid()
 195     const
 196 {
 197     return body_ && body().valid();
 198 }
 199
 200 prefix_ bool senf::FileHandle::boolean_test()
 201     const
 202 {
 203     return valid() && !eof();
 204 }
 205
 206 prefix_ int senf::FileHandle::fd()
 207     const
 208 {
 209     return body().fd();
 210 }
 211
 212 prefix_ senf::FileHandle::FileHandle()
 213     : body_(0)
 214 {}
 215
 216 prefix_ senf::FileHandle::~FileHandle()
 217 {
 218     if (body_ && ! body().is_shared())
 219         body().destroyClose();
 220 }
 221
 222 prefix_  senf::FileHandle::FileHandle(std::auto_ptr<FileBody> body)
 223     : body_(body.release())
 224 {}
 225
 226 prefix_ senf::FileHandle::FileHandle(FileBody::ptr body)
 227     : body_(body)
 228 {}
 229
 230 prefix_ senf::FileBody & senf::FileHandle::body(FileHandle & handle)
 231 {
 232     return handle.body();
 233 }
 234
 235 prefix_ senf::FileBody const & senf::FileHandle::body(FileHandle const & handle)
 236 {
 237     return handle.body();
 238 }
 239
 240 prefix_ void senf::FileHandle::fd(int fd)
 241 {
 242     body().fd(fd);
 243 }
 244
 245 prefix_ senf::FileHandle senf::FileHandle::cast_static(FileHandle handle)
 246 {
 247     return handle;
 248 }
 249
 250 prefix_ senf::FileHandle senf::FileHandle::cast_dynamic(FileHandle handle)
 251 {
 252     return handle;
 253 }
 254
 255 prefix_ int senf::retrieve_filehandle(FileHandle handle)
 256 {
 257     return handle.fd();
 258 }
 259
 260 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 261 #undef prefix_
 262
 263 \f
 264 // Local Variables:
 265 // mode: c++
 266 // fill-column: 100
 267 // c-file-style: "senf"
 268 // indent-tabs-mode: nil
 269 // ispell-local-dictionary: "american"
 270 // compile-command: "scons -u test"
 271 // comment-column: 40
 272 // End: