blob: 2a3231b7180d156aadb488f080eaa332b8e8cb48 (
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
72
73
74
75
76
77
78
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed 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.
*/
package com.android.net.module.util.async;
import java.io.IOException;
/**
* Represents an EventManager-managed file with Async IO semantics.
*
* Implements level-based Asyn IO semantics. This means that:
* - onReadReady() callback would keep happening as long as there's any remaining
* data to read, or the user calls enableReadEvents(false)
* - onWriteReady() callback would keep happening as long as there's remaining space
* to write to, or the user calls enableWriteEvents(false)
*
* All operations except close() must be called on the EventManager thread.
*
* @hide
*/
public interface AsyncFile {
/**
* Receives notifications when file readability or writeability changes.
* @hide
*/
public interface Listener {
/** Invoked after the underlying file has been closed. */
void onClosed(AsyncFile file);
/** Invoked while the file has readable data and read notifications are enabled. */
void onReadReady(AsyncFile file);
/** Invoked while the file has writeable space and write notifications are enabled. */
void onWriteReady(AsyncFile file);
}
/** Requests this file to be closed. */
void close();
/** Enables or disables onReadReady() events. */
void enableReadEvents(boolean enable);
/** Enables or disables onWriteReady() events. */
void enableWriteEvents(boolean enable);
/** Returns true if the input stream has reached its end, or has been closed. */
boolean reachedEndOfFile();
/**
* Reads available data from the given non-blocking file descriptor.
*
* Returns zero if there's no data to read at this moment.
* Returns -1 if the file has reached its end or the input stream has been closed.
* Otherwise returns the number of bytes read.
*/
int read(byte[] buffer, int pos, int len) throws IOException;
/**
* Writes data into the given non-blocking file descriptor.
*
* Returns zero if there's no buffer space to write to at this moment.
* Otherwise returns the number of bytes written.
*/
int write(byte[] buffer, int pos, int len) throws IOException;
}
|
