OutOfBandInline Property

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

[Visual Basic]
<DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")>
<DefaultValueAttribute()>
<CategoryAttribute("Socket Options")>
Public Property OutOfBandInline As Boolean

[C#]
[DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")]
[DefaultValueAttribute()]
[CategoryAttribute("Socket Options")]
public bool OutOfBandInline {get; set;}

[C++]
[DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")]
[DefaultValueAttribute()]
[CategoryAttribute("Socket Options")]
public: __property bool get_OutOfBandInline();
public: __property void set_OutOfBandInline( 
   bool value
);

[C++/CLI]
[DescriptionAttribute("Gets or Sets a value that indicates whether out-of-band (urgent) data will be read as normal in-line data.")]
[DefaultValueAttribute()]
[CategoryAttribute("Socket Options")]
public:
property bool OutOfBandInline {
   bool get();
   void set (bool value);
}

Return Type

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

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.

Example

The following example demonstrates some of the lesser used Tcp component members.

[Visual Basic]

' 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#]



// 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();

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

Requirements

Language

OutOfBandInline Property

Return Type

Remarks

Example

Requirements

See Also