PowerTCP Mail for .NET
OutOfBandInline Property
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > Tcp Class : OutOfBandInline Property




Gets or sets a value that indicates whether out-of-band (urgent) data is read as normal in-line data.

Syntax

Visual Basic (Declaration) 
<CategoryAttribute("Socket Options")>
<DefaultValueAttribute()>
<DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")>
Public Property OutOfBandInline As Boolean
Visual Basic (Usage)Copy Code
Dim instance As Tcp
Dim value As Boolean
 
instance.OutOfBandInline = value
 
value = instance.OutOfBandInline
C# 
[CategoryAttribute("Socket Options")]
[DefaultValueAttribute()]
[DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")]
public bool OutOfBandInline {get; set;}
Managed Extensions for C++ 
[CategoryAttribute("Socket Options")]
[DefaultValueAttribute()]
[DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")]
public: __property bool get_OutOfBandInline();
public: __property void set_OutOfBandInline( 
   bool value
);
C++/CLI 
[CategoryAttribute("Socket Options")]
[DefaultValueAttribute()]
[DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")]
public:
property bool OutOfBandInline {
   bool get();
   void set (    bool value);
}

Property Value

true if urgent data is to be read as normal in-line data, otherwise false. The default value is false.

Example

The following example demonstrates some of the lesser used Tcp component members.
Visual BasicCopy Code
' Disable UI events.
Tcp1.DoEvents = False

' Enable KeepAlive socket option
Tcp1.KeepAlive = True

' Disable use of Nagle's Algoritm
Tcp1.NoDelay = True

' Read urgent data as normal in-line data.
Tcp1.OutOfBandInline = True

' Allow addresses to be reused
Tcp1.ReuseAddress = True

' Connect
Tcp1.Connect("atropos", 7)

' Send data
Tcp1.Send("test")

' Receive response
Dim seg As Segment = Tcp1.Receive()
C#Copy Code
// Disable UI events.
tcp1.DoEvents = false;

// Enable KeepAlive socket option
tcp1.KeepAlive = true;

// Disable use of Nagle's Algoritm
tcp1.NoDelay = true;

// Read urgent data as normal in-line data.
tcp1.OutOfBandInline = true;

// Allow addresses to be reused
tcp1.ReuseAddress = true

// Connect
tcp1.Connect("atropos", 7);

// Send data
tcp1.Send("test");

// Receive response
Segment seg = tcp1.Receive();

Remarks

When the "urgent" socket flag is set, this means that the packet contains data that should be acted upon before "non-urgent" data. Setting this property to true will cause this urgent data to be read in-line. If this property is set to false, the typical technique used to receive out-of-band data is BeginReceive(SocketFlags.Urgent) which posts a blocking receive on the socket waiting for urgent data to arrive.

To minimize interoperability problems, applications writers are advised not to use out-of-band data unless this is required in order to interoperate with an existing service.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.