WCF-Xtensions Class Reference for Mono
MaxOutboundQueueSize Property (WebSocketTransportBindingElement)






Gets and sets the maximum size for the outbound message queue.
Syntax
'Declaration
 
Public Property MaxOutboundQueueSize As System.Long
'Usage
 
Dim instance As WebSocketTransportBindingElement
Dim value As System.Long
 
instance.MaxOutboundQueueSize = value
 
value = instance.MaxOutboundQueueSize
public System.long MaxOutboundQueueSize {get; set;}
public read-write property MaxOutboundQueueSize: System.Int64; 
public function get,set MaxOutboundQueueSize : System.long
public: __property System.long get_MaxOutboundQueueSize();
public: __property void set_MaxOutboundQueueSize( 
   System.long value
);
public:
property System.int64 MaxOutboundQueueSize {
   System.int64 get();
   void set (    System.int64 value);
}

Property Value

The maximum size of outbound message queue expressed in bytes.
Remarks

Outbound message queue contains the buffered messages pending to be sent to the remote side asynchronously. Only asynchronously send messages get enqueued in the outbound message queue. This property does not have any effect on synchronous send operation and in case transport is configured to use streaming transfer mode.

The size of the outbound message queue is a combined size of all enqueued messages in bytes. In case when channel push outbound asynchronous messages faster than they can be send the queue is growing. If asynchronous message that is being added to the outbound queue, would result in queue exceeding the maximum size set by this property, message is not added to the queue, instead Noemax.WebSockets.WebSocketQueueSizeException is thrown and send operation fails.

Note: This property indirectly impose an addition limitation on the maximum size of outbound message that can be sent asynchronously.

Using message compression like one provided by CompressionBindingElement helps to reduce the size of the messages and so helps to reduce the size of the queue. Using transport level compression by setting CompressionScheme, does not compress message in the queue, but compress entire transport payload right before it is sent. This allows to send the messages faster and this way prevents or slows down the growth of the queue.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

WebSocketTransportBindingElement Class
WebSocketTransportBindingElement Members

Send Feedback