IInputChannel.TryReceive(TimeSpan, Message) Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

IInputChannel.cs

Tries to receive a message within a specified interval of time.

public:
 bool TryReceive(TimeSpan timeout, [Runtime::InteropServices::Out] System::ServiceModel::Channels::Message ^ % message);

public bool TryReceive (TimeSpan timeout, out System.ServiceModel.Channels.Message message);

abstract member TryReceive : TimeSpan * Message -> bool

Public Function TryReceive (timeout As TimeSpan, ByRef message As Message) As Boolean

Parameters

timeout

TimeSpan

The IAsyncResult returned by a call to one of the BeginReceive methods.

message

Message

The Message received.

Returns

Boolean

true if a message is received before the timeout has been exceeded; otherwise false.

Exceptions

TimeoutException

The specified timeout is exceeded before the operation is completed.

ArgumentOutOfRangeException

The timeout specified is less than zero.

Examples

The following code illustrates how to implement this method:

public bool TryReceive(TimeSpan timeout, out Message message)
{
    bool result;
    while (true)
    {
        result = this.InnerChannel.TryReceive(timeout, out message);
        if (ProcessReceivedMessage(ref message))
        {
            break;
        }
    }

    return result;
}

Remarks

If you are going to handle timeouts and not just re-throw or wrap the TimeoutException, then you should call TryReceive(TimeSpan, Message) instead of Receive.

If you are not going to treat timeouts specially then just call Receive, otherwise you will lose error information.