[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] /srv/bzr/gnash/rtmp r9691: add doxygen comment blocks for
From: |
rob |
Subject: |
[Gnash-commit] /srv/bzr/gnash/rtmp r9691: add doxygen comment blocks for private data. |
Date: |
Mon, 03 Nov 2008 12:13:37 -0700 |
User-agent: |
Bazaar (1.5) |
------------------------------------------------------------
revno: 9691
committer: address@hidden
branch nick: rtmp
timestamp: Mon 2008-11-03 12:13:37 -0700
message:
add doxygen comment blocks for private data.
modified:
cygnal/diskstream.h
=== modified file 'cygnal/diskstream.h'
--- a/cygnal/diskstream.h 2008-11-03 18:52:57 +0000
+++ b/cygnal/diskstream.h 2008-11-03 19:13:37 +0000
@@ -1,5 +1,5 @@
//
-// Copyright (C) 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+// Copyright (C) 2008 Free Software Foundation, Inc.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
@@ -23,10 +23,6 @@
#include "gnashconfig.h"
#endif
-//#ifdef HAVE_AIO_H
-//#include <aio.h>
-//#endif
-
#include <string>
#include <iostream>
@@ -127,7 +123,7 @@
/// seek to.
///
/// @return True if the stream was paused sucessfully, false if not.
- bool seek(off_t offset);
+ boost::uint8_t * seek(off_t offset);
/// \bried Upload a file into a sandbox.
/// The sandbox is an area where uploaded files can get
@@ -175,27 +171,60 @@
void dump();
// friend std::ostream& operator<< (std::ostream &os, const DiskStream &ds);
+ /// \brief Get the base address for the memory page.
+ ///
+ /// @return A real pointer to the base address.
boost::uint8_t *get() { return _dataptr; };
+
private:
+ /// \var DiskStream::_state
+ /// The current status of the stream while streaming.
state_e _state;
int _bytes;
+
+ /// \var DiskStream::_filefd
+ /// The file descriptor of the disk file.
int _filefd;
+
+ /// \var DiskStream::_netfd
+ /// The file descriptor of the network connection.
int _netfd;
+
+ /// \var DiskStream::_filespec
+ /// The path and file name of the disk file to stream.
std::string _filespec;
+
+ /// \var DiskStream::_statistics
+ /// The data structure for collecting statistical
+ /// information.
gnash::Statistics _statistics;
+
+ /// \var DiskStream::_dataptr
+ /// The base address of the memory page.
boost::uint8_t *_dataptr;
+
+ /// \var DiskStream::_seekptr
+ /// The current location within the current memory page.
boost::uint8_t *_seekptr;
+
+ /// \var DiskStream::_filesize
+ /// The size of the disk file to stream.
size_t _filesize;
+
+ /// \var DiskStream::_pagesize
+ /// The memory page size.
size_t _pagesize;
+
+ /// \var DiskStream::_offset
+ /// The offset within the file of the current memory
+ /// page.
off_t _offset;
-// struct aiocb _aio_control_block;
+
gnash::CQue _que;
};
} // end of cygnal namespace
-//#endif // HAVE_AIO_H
-
#endif // __DISKSTREAM_H__
// local Variables:
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] /srv/bzr/gnash/rtmp r9691: add doxygen comment blocks for private data.,
rob <=