Release 4.0.0-preview1-00230
[platform/core/csapi/tizenfx.git] / src / Tizen.System.Usb / Usb / UsbBulkEndpoint.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 using System;
18
19 namespace Tizen.System.Usb
20 {
21     /// <summary>
22     /// USB Bulk Endpoint class.
23     /// </summary>
24     public class UsbBulkEndpoint : UsbEndpoint
25     {
26         internal UsbBulkEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle)
27         {
28         }
29
30         /// <summary>
31         /// Performs a USB transfer on given endpoint. Direction of transfer is determined by the endpoint.
32         /// </summary>
33         /// <param name="buffer">Suitably-sized data buffer for either input or output (depending on endpoint).</param>
34         /// <param name="length">
35         /// For writes, the number of bytes from data to be sent, for reads the maximum number of bytes to receive
36         /// into the data buffer.
37         /// </param>
38         /// <param name="timeout">
39         /// Time (in milliseconds) that this function should wait for before giving up due to no response being
40         /// received(for an unlimited timeout 0 value should be used).
41         /// </param>
42         /// <returns>Number of bytes actually transferred.</returns>
43         /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
44         /// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
45         public int Transfer(byte[] buffer, int length, uint timeout)
46         {
47             return TransferImpl(buffer, length, timeout);
48         }
49     }
50 }