Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

ConduitStyle.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file ConduitStyle.d
00004         
00005         Copyright (C) 2004 Kris Bell
00006         
00007         This software is provided 'as-is', without any express or implied
00008         warranty. In no event will the authors be held liable for damages
00009         of any kind arising from the use of this software.
00010         
00011         Permission is hereby granted to anyone to use this software for any 
00012         purpose, including commercial applications, and to alter it and/or 
00013         redistribute it freely, subject to the following restrictions:
00014         
00015         1. The origin of this software must not be misrepresented; you must 
00016            not claim that you wrote the original software. If you use this 
00017            software in a product, an acknowledgment within documentation of 
00018            said product would be appreciated but is not required.
00019 
00020         2. Altered source versions must be plainly marked as such, and must 
00021            not be misrepresented as being the original software.
00022 
00023         3. This notice may not be removed or altered from any distribution
00024            of the source.
00025 
00026 
00027                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00028 
00029 
00030         @version        Initial version, March 2004      
00031         @author         Kris
00032 
00033 
00034 *******************************************************************************/
00035 
00036 module mango.io.ConduitStyle;
00037 
00038 
00039 /*******************************************************************************
00040 
00041         Defines how a Conduit should be opened. This is typically subsumed
00042         by a subclass.        
00043 
00044 *******************************************************************************/
00045 
00046 class ConduitStyle
00047 {
00048         /***********************************************************************
00049         
00050                 Declare the basic styles for a Conduit
00051 
00052         ***********************************************************************/
00053         
00054         enum Access             {
00055                                 Read      = 0x01,
00056                                 Write     = 0x02,
00057                                 ReadWrite = 0x03,
00058                                 };
00059 
00060         private Access          m_access;
00061         
00062         /***********************************************************************
00063         
00064                 Expose common instances of ConduitStyle
00065 
00066         ***********************************************************************/
00067 
00068         static ConduitStyle     Read,
00069                                 Write,
00070                                 ReadWrite;
00071 
00072         /***********************************************************************
00073         
00074                 Setup common instances of ConduitStyle
00075 
00076         ***********************************************************************/
00077 
00078         static this ()
00079         {
00080                 Read      = new ConduitStyle (Access.Read);
00081                 Write     = new ConduitStyle (Access.Write);
00082                 ReadWrite = new ConduitStyle (Access.ReadWrite);
00083         }
00084       
00085         /***********************************************************************
00086         
00087                 Construct a ConduitStyle with the given access
00088 
00089         ***********************************************************************/
00090 
00091         this (Access access)
00092         {
00093                 m_access = access;
00094         }
00095 
00096         /***********************************************************************
00097         
00098                 Return the access attribute of this ConduitStyle
00099 
00100         ***********************************************************************/
00101 
00102         Access access()
00103         {
00104                 return m_access;
00105         }
00106 }

Generated on Sun Nov 7 19:06:50 2004 for Mango by doxygen 1.3.6