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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
// Copyright 2022 The Pigweed Authors
//
// 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
//
// https://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 dev.pigweed.pw_transfer;
import com.google.common.util.concurrent.ListenableFuture;
import dev.pigweed.pw_rpc.MethodClient;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
/**
* Manages ongoing pw_transfer data transfers.
*
* <p>Use TransferClient to send data to and receive data from a pw_transfer service running on a
* pw_rpc server.
*/
public class TransferClient {
public static final TransferParameters DEFAULT_READ_TRANSFER_PARAMETERS =
TransferParameters.create(8192, 1024, 0);
private final TransferTimeoutSettings settings;
private final BooleanSupplier shouldAbortCallback;
private final TransferEventHandler transferEventHandler;
private final Thread transferEventHandlerThread;
private ProtocolVersion desiredProtocolVersion = ProtocolVersion.latest();
/**
* Creates a new transfer client for sending and receiving data with pw_transfer.
*
* @param readMethod Method client for the pw.transfer.Transfer.Read method.
* @param writeMethod Method client for the pw.transfer.Transfer.Write method.
* @param settings Settings for timeouts and retries.
*/
public TransferClient(
MethodClient readMethod, MethodClient writeMethod, TransferTimeoutSettings settings) {
this(readMethod, writeMethod, settings, () -> false, TransferEventHandler::run);
}
/**
* Creates a new transfer client with a callback that can be used to terminate transfers.
*
* @param shouldAbortCallback BooleanSupplier that returns true if a transfer should be aborted.
*/
public TransferClient(MethodClient readMethod,
MethodClient writeMethod,
int transferTimeoutMillis,
int initialTransferTimeoutMillis,
int maxRetries,
BooleanSupplier shouldAbortCallback) {
this(readMethod,
writeMethod,
TransferTimeoutSettings.builder()
.setTimeoutMillis(transferTimeoutMillis)
.setInitialTimeoutMillis(initialTransferTimeoutMillis)
.setMaxRetries(maxRetries)
.build(),
shouldAbortCallback,
TransferEventHandler::run);
}
/** Constructor exposed to package for test use only. */
TransferClient(MethodClient readMethod,
MethodClient writeMethod,
TransferTimeoutSettings settings,
BooleanSupplier shouldAbortCallback,
Consumer<TransferEventHandler> runFunction) {
this.settings = settings;
this.shouldAbortCallback = shouldAbortCallback;
transferEventHandler = new TransferEventHandler(readMethod, writeMethod);
transferEventHandlerThread = new Thread(() -> runFunction.accept(transferEventHandler));
transferEventHandlerThread.start();
}
/** Writes the provided data to the given transfer resource. */
public ListenableFuture<Void> write(int resourceId, byte[] data) {
return write(resourceId, data, transferProgress -> {});
}
/**
* Writes data to the specified transfer resource, calling the progress
* callback as data is sent.
*
* @param resourceId The ID of the resource to which to write
* @param data the data to write
* @param progressCallback called each time a packet is sent
*/
public ListenableFuture<Void> write(
int resourceId, byte[] data, Consumer<TransferProgress> progressCallback) {
return transferEventHandler.startWriteTransferAsClient(
resourceId, desiredProtocolVersion, settings, data, progressCallback, shouldAbortCallback);
}
/** Reads the data from the given transfer resource ID. */
public ListenableFuture<byte[]> read(int resourceId) {
return read(resourceId, DEFAULT_READ_TRANSFER_PARAMETERS, progressCallback -> {});
}
/** Reads the data for a transfer resource, calling the progress callback as data is received. */
public ListenableFuture<byte[]> read(
int resourceId, Consumer<TransferProgress> progressCallback) {
return read(resourceId, DEFAULT_READ_TRANSFER_PARAMETERS, progressCallback);
}
/** Reads the data for a transfer resource, using the specified transfer parameters. */
public ListenableFuture<byte[]> read(int resourceId, TransferParameters parameters) {
return read(resourceId, parameters, (progressCallback) -> {});
}
/**
* Reads the data for a transfer resource, using the specified parameters and progress callback.
*/
public ListenableFuture<byte[]> read(
int resourceId, TransferParameters parameters, Consumer<TransferProgress> progressCallback) {
return transferEventHandler.startReadTransferAsClient(resourceId,
desiredProtocolVersion,
settings,
parameters,
progressCallback,
shouldAbortCallback);
}
/**
* Sets the protocol version to request for future transfers
*
* Does not affect ongoing transfers. Version cannot be set to UNKNOWN!
*
* @throws IllegalArgumentException if the protocol version is UNKNOWN
*/
public void setProtocolVersion(ProtocolVersion version) {
if (version == ProtocolVersion.UNKNOWN) {
throw new IllegalArgumentException("Cannot set protocol version to UNKNOWN!");
}
desiredProtocolVersion = version;
}
/** Stops the background thread and waits until it terminates. */
public void close() throws InterruptedException {
transferEventHandler.stop();
transferEventHandlerThread.join();
}
void waitUntilEventsAreProcessedForTest() {
transferEventHandler.waitUntilEventsAreProcessedForTest();
}
}
|
