Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | 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         4. Derivative works are permitted, but they must carry this notice
00027            in full and credit the original source.
00028 
00029 
00030                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00031 
00032 
00033         @version        Initial version, March 2004      
00034         @author         Kris
00035 
00036 
00037 *******************************************************************************/
00038 
00039 module mango.io.ConduitStyle;
00040 
00041 
00042 /*******************************************************************************
00043 
00044         Defines how a Conduit should be opened. This is typically subsumed
00045         by a subclass.        
00046 
00047 *******************************************************************************/
00048 
00049 class ConduitStyle
00050 {
00051         /***********************************************************************
00052         
00053                 Declare the basic styles for a Conduit
00054 
00055         ***********************************************************************/
00056         
00057         enum Access             {
00058                                 Read      = 0x01,
00059                                 Write     = 0x02,
00060                                 ReadWrite = 0x03,
00061                                 };
00062 
00063         private Access          m_access;
00064         
00065         /***********************************************************************
00066         
00067                 Expose common instances of ConduitStyle
00068 
00069         ***********************************************************************/
00070 
00071         static ConduitStyle     Read,
00072                                 Write,
00073                                 ReadWrite;
00074 
00075         /***********************************************************************
00076         
00077                 Setup common instances of ConduitStyle
00078 
00079         ***********************************************************************/
00080 
00081         static this ()
00082         {
00083                 Read      = new ConduitStyle (Access.Read);
00084                 Write     = new ConduitStyle (Access.Write);
00085                 ReadWrite = new ConduitStyle (Access.ReadWrite);
00086         }
00087       
00088         /***********************************************************************
00089         
00090                 Construct a ConduitStyle with the given access
00091 
00092         ***********************************************************************/
00093 
00094         this (Access access)
00095         {
00096                 m_access = access;
00097         }
00098 
00099         /***********************************************************************
00100         
00101                 Return the access attribute of this ConduitStyle
00102 
00103         ***********************************************************************/
00104 
00105         Access access()
00106         {
00107                 return m_access;
00108         }
00109 }

Generated on Fri May 27 18:11:55 2005 for Mango by  doxygen 1.4.0