Skip to main content

Uploading file streams over HTTP using WCF

Although WCF is really great, for some scenario’s it can be really hard to get everything up and running correctly. One of these scenario’s is uploading files.

Some important considerations:

Choose wisely between the streamed and buffered option

You have two main options for uploading files in WCF:

  • streamed
  • buffered/chunked

If you want to have reliable data transfer you’ll have to use the buffered/chunked option. Reliable messaging cannot be used with streaming as the WS-RM mechanism requires processing the data as a unity to apply checksums, etc. If you do not need the robustness of reliable messaging, streaming lets you transfer large amount of data using small message buffers without the overhead of implementing chuncking.

Secure your streams

Streaming over HTTP requires you to use basicHttpBinding; thus you will need SSL to encrypt the transferred data. Buffered transfer, on the other hand, can use wsHttpBinding, which by default provides integrity and confidentiality for your messages; thus there is no need for SSL then.

Use message headers for meta-data

   1:  [OperationContract(Action = "UploadFile", IsOneWay = true)] 
   2:  void UploadFile(UploadMessage request); 
   3:   
   4:  [MessageContract] 
   5:  public class UploadMessage 
   6:  { 
   7:     [MessageHeader]
   8:     public string MetaData{get;set;}  
   9:     [MessageBodyMember]
  10:     public System.IO.Stream File{get;set;}
  11:  }


WCF requires that the stream object is the only item in the message body for a streamed operation. Therefore headers are the recommended way for sending meta-data when streaming.


Configure the transferMode on the client


The setting for transferMode does not propagate to clients when using a HTTP binding. You must manually edit the client config file to set transferMode = "Streamed" after using 'Add service reference' or running SVCUTIL.EXE.


ASP.NET Developer Server limitations


If you try to run your streaming webservice, expect a big failure. Cassini support neither streamed transfers/MTOM encoding neither SSL.

So configure your service to be hosted in IIS.


Uploading large data streams over HTTP


WCF streaming is not only limited by the maxReceivedMessageSize settingb but also by IIS/ASP.NET who has a limit on the size of a HTTP request to prevent denial-of-service attacks. So for WCF streaming in IIS to work properly, you need to update your web.config and add following line:


   1:  <!-- maxRequestLength (in KB) max size: 2048MB --> 
   2:  <httpRuntime maxRequestLength="2000000" />

After that you are finally streaming large amounts of data over HTTPS.

Labels:

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Cache stampede: when our cache turned against us

While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...
Read more

A complex system designed from scratch never works

A few years ago, I worked as an architect on a big mainframe rewrite. I still count it as one of my failures. Not because the technology was wrong, but because I couldn't convince the management team to simplify the approach. Years later, the organization is still struggling to get the new system up and running. I left the project at the time, because I couldn't put my name behind an approach that would take very long and cost a lot of money without a working system to show for it along the way. Gall’s Law That memory keeps coming back to me, because it's a textbook case of Gall's Law playing out in real life. Gall's Law , from John Gall's Systemantics , states it plainly: A complex system that works is invariably found to have evolved from a simple system that worked. A complex system designed from scratch never works, and it cannot be patched to make it work. You have to start over with a simple system that works. What does that mean in practice,...
Read more