-
Notifications
You must be signed in to change notification settings - Fork 180
/
StreamingHttpService.java
55 lines (50 loc) · 1.93 KB
/
StreamingHttpService.java
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
/*
* Copyright © 2018 Apple Inc. and the ServiceTalk project 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
*
* 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 io.servicetalk.http.api;
import io.servicetalk.concurrent.api.AsyncCloseable;
import io.servicetalk.concurrent.api.Completable;
import io.servicetalk.concurrent.api.Single;
import static io.servicetalk.concurrent.api.Completable.completed;
/**
* A service contract for the HTTP protocol.
*/
@FunctionalInterface
public interface StreamingHttpService extends AsyncCloseable, HttpExecutionStrategyInfluencer {
/**
* Handles a single HTTP request.
*
* @param ctx Context of the service.
* @param request to handle.
* @param responseFactory used to create {@link StreamingHttpResponse} objects.
* @return {@link Single} of HTTP response.
*/
Single<StreamingHttpResponse> handle(HttpServiceContext ctx, StreamingHttpRequest request,
StreamingHttpResponseFactory responseFactory);
/**
* Closes this {@link StreamingHttpService} asynchronously.
*
* @return {@link Completable} that when subscribed will close this {@link StreamingHttpService}.
*/
@Override
default Completable closeAsync() {
return completed();
}
@Override
default HttpExecutionStrategy requiredOffloads() {
// safe default--implementations are expected to override
return HttpExecutionStrategies.offloadAll();
}
}