io.aeron.driver.media.UdpTransportPoller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aeron-all Show documentation

Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.

There is a newer version: 1.48.0

/*
 * Copyright 2014-2024 Real Logic Limited.
 *
 * 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 io.aeron.driver.media;

import org.agrona.ErrorHandler;
import org.agrona.nio.TransportPoller;

import java.nio.channels.SelectionKey;

/**
 * Encapsulates the polling of a number of {@link UdpChannelTransport}s using whatever means provides the lowest latency.
 */
public abstract class UdpTransportPoller extends TransportPoller
{
    /**
     * {@link ErrorHandler} which can be used to log errors and continue.
     */
    protected final ErrorHandler errorHandler;

    /**
     * Construct a new {@link TransportPoller} with an {@link ErrorHandler} for logging.
     *
     * @param errorHandler which can be used to log errors and continue.
     */
    public UdpTransportPoller(final ErrorHandler errorHandler)
    {
        this.errorHandler = errorHandler;
    }

    /**
     * Explicit event loop processing as a poll
     *
     * @return the number of frames processed.
     */
    public abstract int pollTransports();

    /**
     * Register channel for read.
     *
     * @param transport to associate with read.
     * @return {@link SelectionKey} for registration to cancel.
     */
    public abstract SelectionKey registerForRead(UdpChannelTransport transport);

    /**
     * Cancel previous registration.
     *
     * @param transport to cancel read for
     */
    public abstract void cancelRead(UdpChannelTransport transport);
}