public void S3_EUSB_OperateIo_GetCurrentFrameNumber()
{
LogComment("S3_EUSB_OperateIo_GetCurrentFrameNumber");
LogComment("1. Creates the control virtual channel, exchanges capabilities then notifies that the channel is created.");
context.ControlChannel = CreateVirtualChannel();
LogComment("2. Receives an add virtual channel request.");
rdpeusbAdapter.ExpectAddVirtualChannel(context.ControlChannel);
LogComment("3. Creates a new virtual channel for the device.");
DynamicVirtualChannel channel = CreateVirtualChannel();
LogComment("4. Receives an add device request.");
EusbDeviceContext device = rdpeusbAdapter.ExpectAddDevice(channel);
LogComment("5. Registers a callback to provide the Request Completion Interface to the client.");
uint interfaceId = IdGenerator.NewId();
rdpeusbAdapter.RegisterCallback(device, 1, interfaceId);
LogComment("6. Sends TS_URB_GET_CURRENT_FRAME_NUMBER request.");
const uint frameNumberSize = 0;
uint requestId = IdGenerator.NewId();
TS_URB_GET_CURRENT_FRAME_NUMBER req = new TS_URB_GET_CURRENT_FRAME_NUMBER(
requestId,
0);
rdpeusbAdapter.TransferInRequest(device, req, frameNumberSize);
LogComment("7. Receives TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT in the URB_COMPLETION_NO_DATA message.");
// Waits for the result.
EusbPdu pdu = rdpeusbAdapter.ExpectCompletion(device.VirtualChannel);
Site.Assert.IsInstanceOfType(
pdu,
typeof(EusbUrbCompletionNoDataPdu),
"The result must be type of EusbUrbCompletionNoDataPdu.");
EusbUrbCompletionNoDataPdu pduRes = (EusbUrbCompletionNoDataPdu)pdu;
Site.Assert.IsSuccess((int)pduRes.HResult, "The EusbUrbCompletionNoDataPdu must indicate successful.");
ReqCapturer.VerifyUrbCompletionNoData(pduRes, req, true, interfaceId);
TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT res = new TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT();
Site.Assert.IsTrue(
PduMarshaler.Unmarshal(pduRes.TsUrbResult, res),
"The TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT structure is sent via the URB_COMPLETION_NO_DATA message"
);
LogComment("The current frame number is {0}(0x{0:x4}).", res.FrameNumber);
LogComment("8. Sends retract device request and the channel for the device is expected to be closed.");
rdpeusbAdapter.RetractDevice(device, USB_RETRACT_REASON.UsbRetractReason_BlockedByPolicy);
}
/// <summary>
/// This method is used to verify the URB_COMPLETION_NO_DATA PDU.
/// </summary>
/// <param name="responsePdu">The PDU from the client.</param>
/// <param name="tsUrb">The TS_URB in the request.</param>
/// <param name="isTransferInRequest">This specify if the request is TRANSFER_IN_REQUEST or TRANSFER_OUT_REQUEST.</param>
/// <param name="requestCompletion">A unique InterfaceID to be set in the Register Request Callback Message.</param>
public static void VerifyUrbCompletionNoData(EusbUrbCompletionNoDataPdu responsePdu, TS_URB tsUrb, bool isTransferInRequest, uint requestCompletion)
{
Site.Assert.AreEqual<uint>(
requestCompletion,
responsePdu.InterfaceId,
"Expect that the InterfaceId in the response PDU equals the RequestCompletion field of the REGISTER_REQUEST_CALLBACK PDU. The actual value is 0x{0:x8}.",
responsePdu.InterfaceId);
Site.Assert.AreEqual<Mask_Values>(
Mask_Values.STREAM_ID_PROXY,
responsePdu.Mask,
"Expect that the Mask in the response PDU is STREAM_ID_PROXY.");
Site.Assert.AreEqual<FunctionId_Values>(
FunctionId_Values.URB_COMPLETION_NO_DATA,
(FunctionId_Values)responsePdu.FunctionId,
"Expect that the FunctionId in the response PDU is CHANNEL_CREATED. The actual value is 0x{0:x8}.",
responsePdu.FunctionId);
Site.Assert.AreEqual<uint>(
tsUrb.Header.RequestId,
responsePdu.RequestId,
"Expect that the RequestId in the response PDU equals the RequestId in the request PDU. The actual value is 0x{0:x8}.",
responsePdu.RequestId);
if (isTransferInRequest)
{
#region Verify Response For TRANSFER_IN_REQUEST
Site.Assert.AreEqual<uint>(
0,
responsePdu.OutputBufferSize,
"Expect that the OutputBufferSize in the response PDU is zero. The actual value is 0x{0:x8}.",
responsePdu.OutputBufferSize);
if (tsUrb is TS_URB_SELECT_CONFIGURATION)
{
#region Verify TS_URB_SELECT_CONFIGURATION_RESULT
Site.Log.Add(LogEntryKind.Debug,
"Expect the TsUrbResult is TS_URB_SELECT_CONFIGURATION_RESULT when the TsUrb in the request is TS_URB_SELECT_CONFIGURATION.");
TS_URB_SELECT_CONFIGURATION_RESULT urb = new TS_URB_SELECT_CONFIGURATION_RESULT();
if (!PduMarshaler.Unmarshal(responsePdu.TsUrbResult, urb))
{
// TsUrbResult can not be unmarshaled to TS_URB_SELECT_CONFIGURATION_RESULT
TS_URB_UNKNOWN unknowUrb = new TS_URB_UNKNOWN();
Site.Assume.IsTrue(PduMarshaler.Unmarshal(responsePdu.TsUrbResult, unknowUrb),
"Marshaling the data to an unknown PDU MUST succeed.");
Site.Log.Add(LogEntryKind.CheckFailed,
"The TsUrbResult is not valid TS_URB_SELECT_CONFIGURATION_RESULT. The data is:\r\n{0}", unknowUrb.ToString());
}
else
{
Site.Log.Add(LogEntryKind.CheckSucceeded, "The TsUrbResult is expected TS_URB_SELECT_CONFIGURATION_RESULT.");
}
#endregion
}
else if (tsUrb is TS_URB_SELECT_INTERFACE)
{
#region Verify TS_URB_SELECT_INTERFACE_RESULT
Site.Log.Add(LogEntryKind.Debug,
"Expect the TsUrbResult is TS_URB_SELECT_INTERFACE_RESULT when the TsUrb in the request is TS_URB_SELECT_INTERFACE.");
TS_URB_SELECT_INTERFACE_RESULT urb = new TS_URB_SELECT_INTERFACE_RESULT();
if (!PduMarshaler.Unmarshal(responsePdu.TsUrbResult, urb))
{
// TsUrbResult can not be unmarshaled to TS_URB_SELECT_INTERFACE_RESULT
TS_URB_UNKNOWN unknowUrb = new TS_URB_UNKNOWN();
Site.Assume.IsTrue(PduMarshaler.Unmarshal(responsePdu.TsUrbResult, unknowUrb),
"Marshaling the data to an unknown PDU MUST succeed.");
Site.Log.Add(LogEntryKind.CheckFailed,
"The TsUrbResult is not valid TS_URB_SELECT_INTERFACE_RESULT. The data is:\r\n{0}", unknowUrb.ToString());
}
else
{
Site.Log.Add(LogEntryKind.CheckSucceeded, "The TsUrbResult is expected TS_URB_SELECT_INTERFACE_RESULT.");
}
#endregion
}
else if (tsUrb is TS_URB_GET_CURRENT_FRAME_NUMBER)
{
#region Verify TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT
Site.Log.Add(LogEntryKind.Debug,
"Expect the TsUrbResult is TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT when the TsUrb in the request is TS_URB_GET_CURRENT_FRAME_NUMBER.");
TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT urb = new TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT();
if (!PduMarshaler.Unmarshal(responsePdu.TsUrbResult, urb))
{
// TsUrbResult can not be unmarshaled to TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT
TS_URB_UNKNOWN unknowUrb = new TS_URB_UNKNOWN();
Site.Assume.IsTrue(PduMarshaler.Unmarshal(responsePdu.TsUrbResult, unknowUrb),
"Marshaling the data to an unknown PDU MUST succeed.");
Site.Log.Add(LogEntryKind.CheckFailed,
"The TsUrbResult is not valid TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT. The data is:\r\n{0}", unknowUrb.ToString());
}
else
{
Site.Log.Add(LogEntryKind.CheckSucceeded, "The TsUrbResult is expected TS_URB_GET_CURRENT_FRAME_NUMBER_RESULT.");
}
#endregion
}
#endregion
}
else
{
#region Verify Response For TRANSFER_OUT_REQUEST
Site.Assert.AreNotEqual<uint>(
0,
responsePdu.OutputBufferSize,
"Expect that the OutputBufferSize in the response PDU is not zero. The actual value is 0x{0:x8}.",
responsePdu.OutputBufferSize);
#endregion
}
#region Verify TS_URB_ISOCH_TRANSFER_RESULT
if (tsUrb is TS_URB_ISOCH_TRANSFER)
{
Site.Log.Add(LogEntryKind.Debug,
"Expect the TsUrbResult is TS_URB_ISOCH_TRANSFER_RESULT when the TsUrb in the request is TS_URB_ISOCH_TRANSFER.");
TS_URB_ISOCH_TRANSFER_RESULT urb = new TS_URB_ISOCH_TRANSFER_RESULT();
if (!PduMarshaler.Unmarshal(responsePdu.TsUrbResult, urb))
{
// TsUrbResult can not be unmarshaled to TS_URB_ISOCH_TRANSFER_RESULT
TS_URB_UNKNOWN unknowUrb = new TS_URB_UNKNOWN();
Site.Assume.IsTrue(PduMarshaler.Unmarshal(responsePdu.TsUrbResult, unknowUrb),
"Marshaling the data to an unknown PDU MUST succeed.");
Site.Log.Add(LogEntryKind.CheckFailed,
"The TsUrbResult is not valid TS_URB_ISOCH_TRANSFER_RESULT. The data is:\r\n{0}", unknowUrb.ToString());
}
else
{
Site.Log.Add(LogEntryKind.CheckSucceeded, "Expect that the TsUrbResult is TS_URB_ISOCH_TRANSFER_RESULT.");
}
}
#endregion
}
