1 /*
2 * Copyright 2016 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.handler.codec.http2;
17
18 import io.netty5.util.internal.UnstableApi;
19
20 /**
21 * A visitor that allows to iterate over a collection of {@link Http2FrameStream}s.
22 */
23 @UnstableApi
24 public interface Http2FrameStreamVisitor {
25
26 /**
27 * This method is called once for each stream of the collection.
28 *
29 * <p>If an {@link Exception} is thrown, the loop is stopped.
30 *
31 * @return <ul>
32 * <li>{@code true} if the visitor wants to continue the loop and handle the stream.</li>
33 * <li>{@code false} if the visitor wants to stop handling the stream and abort the loop.</li>
34 * </ul>
35 */
36 boolean visit(Http2FrameStream stream);
37 }