blob: 35806f2a6e98689d435182ab0089274c4eaa57c9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
using System;
using Apache.Qpid.Buffer;
namespace Apache.Qpid.Client.Transport
{
/// <summary>
/// Represents input/output channels that read
/// and write <see cref="ByteBuffer"/> instances
/// </summary>
public interface IByteChannel
{
/// <summary>
/// Read a <see cref="ByteBuffer"/> from the underlying
/// network stream and any configured filters
/// </summary>
/// <returns>A ByteBuffer, if available</returns>
ByteBuffer Read();
/// <summary>
/// Begin an asynchronous read operation
/// </summary>
/// <param name="callback">Callback method to call when read operation completes</param>
/// <param name="state">State object</param>
/// <returns>An <see cref="System.IAsyncResult"/> object</returns>
IAsyncResult BeginRead(AsyncCallback callback, object state);
/// <summary>
/// End an asynchronous read operation
/// </summary>
/// <param name="result">The <see cref="System.IAsyncResult"/> object returned from <see cref="BeginRead"/></param>
/// <returns>The <see cref="ByteBuffer"/> read</returns>
ByteBuffer EndRead(IAsyncResult result);
/// <summary>
/// Write a <see cref="ByteBuffer"/> to the underlying network
/// stream, going through any configured filters
/// </summary>
/// <param name="buffer"></param>
void Write(ByteBuffer buffer);
/// <summary>
/// Begin an asynchronous write operation
/// </summary>
/// <param name="buffer">Buffer to write</param>
/// <param name="callback">A callback to call when the operation completes</param>
/// <param name="state">State object</param>
/// <returns>An <see cref="System.IAsyncResult"/> object</returns>
IAsyncResult BeginWrite(ByteBuffer buffer, AsyncCallback callback, object state);
/// <summary>
/// End an asynchronous write operation
/// </summary>
/// <param name="result">The <see cref="System.IAsyncResult"/> object returned by <see cref="BeginWrite"/></param>
void EndWrite(IAsyncResult result);
}
}
|
