Как включать потоковую передачу

Windows Communication Foundation (WCF) позволяет передавать сообщения в режиме буферизованной или потоковой передачи. По умолчанию используется режим буферизованной передачи, в случае которого сообщение должно быть доставлено полностью, прежде чем получатель сможет его прочитать. При использовании режима потоковой передачи получатель может начать обработку сообщения до того, как оно будет доставлено полностью. Режим потоковой передачи полезно использовать при большой длине передаваемых данных, которые могут обрабатываться последовательно. Режим потоковой передачи также может быть полезен, когда размер сообщения слишком велик для выполнения полной буферизации.

Для включения потоковой передачи необходимо соответствующим образом определить контракт операции OperationContract и включить потоковую передачу на транспортном уровне.

Потоковая передача данных

1. Для выполнения потоковой передачи контракт операции OperationContract для службы должен удовлетворять двум требованиям.

   1. Параметр, в котором содержатся данные для потоковой передачи, должен быть единственным в методе. Например, если требуется выполнить потоковую передачу входного сообщения, операция должна иметь точно один входной параметр. Аналогично, если требуется выполнить потоковую передачу выходного сообщения, операция должна иметь точно один выходной параметр или возвращать значение.

   2. Параметр и возвращаемое значение должны принадлежать по крайней мере к одному из следующих типов: Stream, Message или IXmlSerializable.

   Ниже приведен пример контракта для потоковой передачи данных.

   <ServiceContract(Namespace:="http://Microsoft.ServiceModel.Samples")> _
   Public Interface IStreamingSample
       <OperationContract()> _
       Function GetStream(ByVal data As String) As Stream
       <OperationContract()> _
       Function UploadStream(ByVal stream As Stream) As Boolean
       <OperationContract()> _
       Function EchoStream(ByVal stream As Stream) As Stream
       <OperationContract()> _
       Function GetReversedStream() As Stream
   
   End Interface
   

   [ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]
   public interface IStreamingSample
   {
       [OperationContract]
       Stream GetStream(string data);
       [OperationContract]
       bool UploadStream(Stream stream);
       [OperationContract]
       Stream EchoStream(Stream stream);
       [OperationContract]
       Stream GetReversedStream();
   
   }
   

   Операция GetStream получает часть буферизованных входных данных в качестве строки (string), которая является буферизованной, и возвращает объект Stream, который является потоковым. UploadStream, наоборот, принимает объект Stream (потоковый) и возвращает объект bool (буферизованный). EchoStream принимает и возвращает объект Stream и является примером операции, в которой как входное, так и выходное сообщение являются потоковыми. Наконец, GetReversedStream не принимает никакие данные и возвращает объект Stream (потоковый).

2. Потоковая передача должна быть включена в привязке. Задаваемое свойство TransferMode может принимать одно из следующих значений.

   1. Buffered.

   2. Streamed. Обеспечивает потоковую передачу в обоих направлениях.

   3. StreamedRequest. Обеспечивает только потоковую передачу запроса.

   4. StreamedResponse. Обеспечивает только потоковую передачу ответа.

   BasicHttpBinding предоставляет свойство TransferMode в привязке, как делают NetTcpBinding и NetNamedPipeBinding. Свойство TransferMode можно также задать в элементе привязки транспорта и использовать в пользовательской привязке.

   В следующих примерах показано, как задать свойство TransferMode с помощью кода и путем изменения файла конфигурации. В обоих примерах для свойства maxReceivedMessageSize задается значение 64 МБ, определяющее максимальный размер принимаемых сообщений. По умолчанию для свойства maxReceivedMessageSize задано значение 64 КБ, которое обычно слишком мало для сценариев потоковой передачи. Это параметр квоты необходимо задавать в соответствии с максимальным размером сообщений, получение которых ожидается приложением. Также обратите внимание, что свойство maxBufferSize контролирует максимальный размер буферизуемых данных; для него требуется задать соответствующее значение.

   1. В следующем фрагменте конфигурации из примера показано задание для свойства TransferMode значения потоковой передачи в привязке basicHttpBinding и пользовательской привязке HTTP.

      <basicHttpBinding>
        <binding name="HttpStreaming" maxReceivedMessageSize="67108864"
                 transferMode="Streamed"/>
      </basicHttpBinding>
      <!-- an example customBinding using Http and streaming-->
      <customBinding>
        <binding name="Soap12">
          <textMessageEncoding messageVersion="Soap12WSAddressing10" />
          <httpTransport transferMode="Streamed" maxReceivedMessageSize="67108864"/>
        </binding>
      </customBinding>
      

   2. В следующем фрагменте кода показано задание для свойства TransferMode значения потоковой передачи в привязке basicHttpBinding и пользовательской привязке HTTP.

      Public Shared Function CreateStreamingBinding() As Binding
          Dim b As New BasicHttpBinding()
          b.TransferMode = TransferMode.Streamed
          Return b
      End Function
      

      public static Binding CreateStreamingBinding()
      {
          BasicHttpBinding b = new BasicHttpBinding();
          b.TransferMode = TransferMode.Streamed;
          return b;
      }
      

   3. В следующем фрагменте кода показано задание для свойства TransferMode значения потоковой передачи в пользовательской привязке TCP.

      Public Shared Function CreateStreamingBinding() As Binding
          Dim transport As New TcpTransportBindingElement()
          transport.TransferMode = TransferMode.Streamed
          Dim binding As New CustomBinding(New BinaryMessageEncodingBindingElement(), _
                                           transport)
          Return binding
      End Function
      

      public static Binding CreateStreamingBinding()
      {
          TcpTransportBindingElement transport = new TcpTransportBindingElement();
          transport.TransferMode = TransferMode.Streamed;
          BinaryMessageEncodingBindingElement encoder = new BinaryMessageEncodingBindingElement();
          CustomBinding binding = new CustomBinding(encoder, transport);
          return binding;
      }
      

3. Операции GetStream, UploadStream и EchoStream выполняют передачу данных непосредственно из файла или сохранение полученных данных непосредственно в файл. Следующий код относится к GetStream.

   Public Function GetStream(ByVal data As String) As Stream Implements IStreamingSample.GetStream
       'this file path assumes the image is in
       ' the Service folder and the service is executing
       ' in service/bin 
       Dim filePath = Path.Combine(System.Environment.CurrentDirectory, ".\..\image.jpg")
       'open the file, this could throw an exception 
       '(e.g. if the file is not found)
       'having includeExceptionDetailInFaults="True" in config 
       ' would cause this exception to be returned to the client
       Try
           Return File.OpenRead(filePath)
       Catch ex As IOException
           Console.WriteLine(String.Format("An exception was thrown while trying to open file {0}", filePath))
           Console.WriteLine("Exception is: ")
           Console.WriteLine(ex.ToString())
           Throw ex
       End Try
   End Function
   

   public Stream GetStream(string data)
   {
       //this file path assumes the image is in
       // the Service folder and the service is executing
       // in service/bin 
       string filePath = Path.Combine(
           System.Environment.CurrentDirectory,
           ".\\..\\image.jpg");
       //open the file, this could throw an exception 
       //(e.g. if the file is not found)
       //having includeExceptionDetailInFaults="True" in config 
       // would cause this exception to be returned to the client
       try
       {
           FileStream imageFile = File.OpenRead(filePath);
           return imageFile;
       }
       catch (IOException ex)
       {
           Console.WriteLine(
               String.Format("An exception was thrown while trying to open file {0}", filePath));
           Console.WriteLine("Exception is: ");
           Console.WriteLine(ex.ToString());
           throw ex;
       }
   }
   

Создание пользовательского потока

1. Для специальной обработки каждого фрагмента потока данных во время его отправки или получения необходимо создать производный класс на основе класса Stream. В следующем примере кода пользовательского потока используется метод GetReversedStream и класс ReverseStream.

   Метод GetReversedStream создает и возвращает новый экземпляр класса ReverseStream. Фактическая обработка происходит, когда система считывает данные из объекта ReverseStream. Метод ReverseStream.Read считывает фрагмент байтов из исходного файла, обращает их, а затем возвращает байты, представленные в обратном порядке. Этот метод не обращает все содержимое файла; он обращает один фрагмент байтов за раз. В этом примере показано, как можно выполнить потоковую обработку во время чтения или записи содержимого из потока.

   Friend Class ReverseStream
       Inherits Stream
   
       Private inStream As FileStream
   
       Friend Sub New(ByVal filePath As String)
           'opens the file and places a StreamReader around it
           inStream = File.OpenRead(filePath)
       End Sub
   
       Public Overrides ReadOnly Property CanRead() As Boolean
           Get
               Return inStream.CanRead
           End Get
       End Property
   
       Public Overrides ReadOnly Property CanSeek() As Boolean
           Get
               Return False
           End Get
       End Property
   
       Public Overrides ReadOnly Property CanWrite() As Boolean
           Get
               Return False
           End Get
       End Property
   
       Public Overrides Sub Flush()
           Throw New Exception("This stream does not support writing.")
       End Sub
   
       Public Overrides ReadOnly Property Length() As Long
           Get
               Throw New Exception("This stream does not support the Length property.")
           End Get
       End Property
   
       Public Overrides Property Position() As Long
           Get
               Return inStream.Position
           End Get
           Set(ByVal value As Long)
               Throw New Exception("This stream does not support setting the Position property.")
           End Set
       End Property
   
       Public Overrides Function Read(ByVal buffer() As Byte, _
                                      ByVal offset As Integer, _
                                      ByVal count As Integer) As Integer
   
           Dim countRead = inStream.Read(buffer, _
                                         offset, _
                                         count)
           ReverseBuffer(buffer, _
                         offset, _
                         countRead)
           Return countRead
       End Function
   
       Public Overrides Function Seek(ByVal offset As Long, _
                                      ByVal origin As SeekOrigin) As Long
           Throw New Exception("This stream does not support seeking.")
       End Function
   
       Public Overrides Sub SetLength(ByVal value As Long)
           Throw New Exception("This stream does not support setting the Length.")
       End Sub
   
       Public Overrides Sub Write(ByVal buffer() As Byte, _
                                  ByVal offset As Integer, _
                                  ByVal count As Integer)
           Throw New Exception("This stream does not support writing.")
       End Sub
   
       Public Overrides Sub Close()
           inStream.Close()
           MyBase.Close()
       End Sub
   
       Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
           inStream.Dispose()
           MyBase.Dispose(disposing)
       End Sub
   
       Private Sub ReverseBuffer(ByVal buffer() As Byte, _
                                 ByVal offset As Integer, _
                                 ByVal count As Integer)
   
           Dim i = offset
           Dim j = offset + count - 1
   
           Do While i < j
               Dim currenti = buffer(i)
               buffer(i) = buffer(j)
               buffer(j) = currenti
               i += 1
               j -= 1
           Loop
   
       End Sub
   End Class
   

   class ReverseStream : Stream
   {
   
       FileStream inStream;
       internal ReverseStream(string filePath)
       {
           //opens the file and places a StreamReader around it
           inStream = File.OpenRead(filePath);
       }
       public override bool CanRead
       {
           get { return inStream.CanRead; }
       }
   
       public override bool CanSeek
       {
           get { return false; }
       }
   
       public override bool CanWrite
       {
           get { return false; }
       }
   
       public override void Flush()
       {
           throw new Exception("This stream does not support writing.");
       }
   
       public override long Length
       {
           get { throw new Exception("This stream does not support the Length property."); }
       }
   
       public override long Position
       {
           get
           {
               return inStream.Position;
           }
           set
           {
               throw new Exception("This stream does not support setting the Position property.");
           }
       }
   
       public override int Read(byte[] buffer, int offset, int count)
       {
           int countRead = inStream.Read(buffer, offset, count);
           ReverseBuffer(buffer, offset, countRead);
           return countRead;
       }
   
       public override long Seek(long offset, SeekOrigin origin)
       {
           throw new Exception("This stream does not support seeking.");
       }
   
       public override void SetLength(long value)
       {
           throw new Exception("This stream does not support setting the Length.");
       }
   
       public override void Write(byte[] buffer, int offset, int count)
       {
           throw new Exception("This stream does not support writing.");
       }
       public override void Close()
       {
           inStream.Close();
           base.Close();
       }
       protected override void Dispose(bool disposing)
       {
           inStream.Dispose();
           base.Dispose(disposing);
       }
       void ReverseBuffer(byte[] buffer, int offset, int count)
       {
   
           int i, j;
   
           for (i = offset, j = offset + count - 1; i < j; i++, j--)
           {
               byte currenti = buffer[i];
               buffer[i] = buffer[j];
               buffer[j] = currenti;
           }
   
       }
   }
   

См. также

Задачи

Поток

Основные понятия

Большие наборы данных и потоковая передача