class/System.Core/System.IO.Pipes/PipeStream.cs

   1 //
   2 // PipeStream.cs
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //
   7 // Copyright (C) 2009 Novell, Inc.  http://www.novell.com
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 #if !BOOTSTRAP_BASIC
  30
  31 using Microsoft.Win32.SafeHandles;
  32 using System;
  33 using System.IO;
  34 using System.Linq;
  35 using System.Security.AccessControl;
  36 using System.Security.Permissions;
  37 using System.Security.Principal;
  38
  39 namespace System.IO.Pipes
  40 {
  41         [PermissionSet (SecurityAction.InheritanceDemand, Name = "FullTrust")]
  42         [HostProtection (SecurityAction.LinkDemand, MayLeakOnAbort = true)]
  43         public abstract class PipeStream : Stream
  44         {
  45                 // FIXME: not precise.
  46                 internal const int DefaultBufferSize = 0x400;
  47
  48                 internal static bool IsWindows {
  49                         get { return Win32Marshal.IsWindows; }
  50                 }
  51
  52                 internal Exception ThrowACLException ()
  53                 {
  54                         return new NotImplementedException ("ACL is not supported in Mono");
  55                 }
  56
  57                 internal static PipeAccessRights ToAccessRights (PipeDirection direction)
  58                 {
  59                         switch (direction) {
  60                         case PipeDirection.In:
  61                                 return PipeAccessRights.ReadData;
  62                         case PipeDirection.Out:
  63                                 return PipeAccessRights.WriteData;
  64                         case PipeDirection.InOut:
  65                                 return PipeAccessRights.ReadData | PipeAccessRights.WriteData;
  66                         default:
  67                                 throw new ArgumentOutOfRangeException ();
  68                         }
  69                 }
  70
  71                 internal static PipeDirection ToDirection (PipeAccessRights rights)
  72                 {
  73                         bool r = (rights & PipeAccessRights.ReadData) != 0;
  74                         bool w = (rights & PipeAccessRights.WriteData) != 0;
  75                         if (r) {
  76                                 if (w)
  77                                         return PipeDirection.InOut;
  78                                 else
  79                                         return PipeDirection.In;
  80                         } else {
  81                                 if (w)
  82                                         return PipeDirection.Out;
  83                                 else
  84                                         throw new ArgumentOutOfRangeException ();
  85                         }
  86                 }
  87
  88                 protected PipeStream (PipeDirection direction, int bufferSize)
  89                         : this (direction, PipeTransmissionMode.Byte, bufferSize)
  90                 {
  91                 }
  92
  93                 protected PipeStream (PipeDirection direction, PipeTransmissionMode transmissionMode, int outBufferSize)
  94                 {
  95                         this.direction = direction;
  96                         this.transmission_mode = transmissionMode;
  97                         read_trans_mode = transmissionMode;
  98                         if (outBufferSize <= 0)
  99                                 throw new ArgumentOutOfRangeException ("bufferSize must be greater than 0");
 100                         buffer_size = outBufferSize;
 101                 }
 102
 103                 PipeDirection direction;
 104                 PipeTransmissionMode transmission_mode, read_trans_mode;
 105                 int buffer_size;
 106                 SafePipeHandle handle;
 107                 Stream stream;
 108
 109                 public override bool CanRead {
 110                         get { return (direction & PipeDirection.In) != 0; }
 111                 }
 112
 113                 public override bool CanSeek {
 114                         get { return false; }
 115                 }
 116
 117                 public override bool CanWrite {
 118                         get { return (direction & PipeDirection.Out) != 0; }
 119                 }
 120
 121                 public virtual int InBufferSize {
 122                         get { return buffer_size; }
 123                 }
 124
 125                 public bool IsAsync { get; private set; }
 126
 127                 public bool IsConnected { get; protected set; }
 128
 129                 internal Stream Stream {
 130                         get {
 131                                 if (!IsConnected)
 132                                         throw new InvalidOperationException ("Pipe is not connected");
 133                                 if (stream == null)
 134                                         stream = new FileStream (handle.DangerousGetHandle (), CanRead ? (CanWrite ? FileAccess.ReadWrite : FileAccess.Read) : FileAccess.Write, true, buffer_size, IsAsync);
 135                                 return stream;
 136                         }
 137                         set { stream = value; }
 138                 }
 139
 140                 protected bool IsHandleExposed { get; private set; }
 141
 142                 [MonoTODO]
 143                 public bool IsMessageComplete { get; private set; }
 144
 145                 [MonoTODO]
 146                 public virtual int OutBufferSize {
 147                         get { return buffer_size; }
 148                 }
 149
 150                 public virtual PipeTransmissionMode ReadMode {
 151                         get {
 152                                 CheckPipePropertyOperations ();
 153                                 return read_trans_mode;
 154                         }
 155                         set {
 156                                 CheckPipePropertyOperations ();
 157                                 read_trans_mode = value;
 158                         }
 159                 }
 160
 161                 public SafePipeHandle SafePipeHandle {
 162                         get {
 163                                 CheckPipePropertyOperations ();
 164                                 return handle;
 165                         }
 166                 }
 167
 168                 public virtual PipeTransmissionMode TransmissionMode {
 169                         get {
 170                                 CheckPipePropertyOperations ();
 171                                 return transmission_mode;
 172                         }
 173                 }
 174
 175                 // initialize/dispose/state check
 176
 177                 [MonoTODO]
 178                 protected internal virtual void CheckPipePropertyOperations ()
 179                 {
 180                 }
 181
 182                 [MonoTODO]
 183                 protected internal void CheckReadOperations ()
 184                 {
 185                         if (!IsConnected)
 186                                 throw new InvalidOperationException ("Pipe is not connected");
 187                         if (!CanRead)
 188                                 throw new NotSupportedException ("The pipe stream does not support read operations");
 189                 }
 190
 191                 [MonoTODO]
 192                 protected internal void CheckWriteOperations ()
 193                 {
 194                         if (!IsConnected)
 195                                 throw new InvalidOperationException ("Pipe us not connected");
 196                         if (!CanWrite)
 197                                 throw new NotSupportedException ("The pipe stream does not support write operations");
 198                 }
 199
 200                 protected void InitializeHandle (SafePipeHandle handle, bool isExposed, bool isAsync)
 201                 {
 202                         this.handle = handle;
 203                         this.IsHandleExposed = isExposed;
 204                         this.IsAsync = isAsync;
 205                 }
 206
 207                 protected override void Dispose (bool disposing)
 208                 {
 209                         if (handle != null && disposing)
 210                                 handle.Dispose ();
 211                 }
 212
 213                 // not supported
 214
 215                 public override long Length {
 216                         get { throw new NotSupportedException (); }
 217                 }
 218
 219                 public override long Position {
 220                         get { return 0; }
 221                         set { throw new NotSupportedException (); }
 222                 }
 223
 224                 public override void SetLength (long value)
 225                 {
 226                         throw new NotSupportedException ();
 227                 }
 228
 229                 public override long Seek (long offset, SeekOrigin origin)
 230                 {
 231                         throw new NotSupportedException ();
 232                 }
 233
 234                 [MonoNotSupported ("ACL is not supported in Mono")]
 235                 public PipeSecurity GetAccessControl ()
 236                 {
 237                         throw ThrowACLException ();
 238                 }
 239
 240                 [MonoNotSupported ("ACL is not supported in Mono")]
 241                 public void SetAccessControl (PipeSecurity pipeSecurity)
 242                 {
 243                         throw ThrowACLException ();
 244                 }
 245
 246                 // pipe I/O
 247
 248                 public void WaitForPipeDrain ()
 249                 {
 250                 }
 251
 252                 [MonoTODO]
 253                 public override int Read (byte [] buffer, int offset, int count)
 254                 {
 255                         CheckReadOperations ();
 256
 257                         return Stream.Read (buffer, offset, count);
 258                 }
 259
 260                 [MonoTODO]
 261                 public override int ReadByte ()
 262                 {
 263                         CheckReadOperations ();
 264
 265                         return Stream.ReadByte ();
 266                 }
 267
 268                 [MonoTODO]
 269                 public override void Write (byte [] buffer, int offset, int count)
 270                 {
 271                         CheckWriteOperations ();
 272
 273                         Stream.Write (buffer, offset, count);
 274                 }
 275
 276                 [MonoTODO]
 277                 public override void WriteByte (byte value)
 278                 {
 279                         CheckWriteOperations ();
 280
 281                         Stream.WriteByte (value);
 282                 }
 283
 284                 [MonoTODO]
 285                 public override void Flush ()
 286                 {
 287                         CheckWriteOperations ();
 288
 289                         Stream.Flush ();
 290                 }
 291
 292                 // async
 293
 294                 Func<byte [],int,int,int> read_delegate;
 295
 296                 [HostProtection (SecurityAction.LinkDemand, ExternalThreading = true)]
 297                 public override IAsyncResult BeginRead (byte [] buffer, int offset, int count, AsyncCallback callback, object state)
 298                 {
 299                         if (read_delegate == null)
 300                                 read_delegate = new Func<byte[],int,int,int> (Read);
 301                         return read_delegate.BeginInvoke (buffer, offset, count, callback, state);
 302                 }
 303
 304                 Action<byte[],int,int> write_delegate;
 305
 306                 [HostProtection (SecurityAction.LinkDemand, ExternalThreading = true)]
 307                 public override IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback callback, object state)
 308                 {
 309                         if (write_delegate == null)
 310                                 write_delegate = new Action<byte[],int,int> (Write);
 311                         return write_delegate.BeginInvoke (buffer, offset, count, callback, state);
 312                 }
 313
 314                 public override int EndRead (IAsyncResult asyncResult)
 315                 {
 316                         return read_delegate.EndInvoke (asyncResult);
 317                 }
 318
 319                 public override void EndWrite (IAsyncResult asyncResult)
 320                 {
 321                         write_delegate.EndInvoke (asyncResult);
 322                 }
 323         }
 324 }
 325
 326 #endif