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

Go to download

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

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

The newest version!

/*
 * Copyright 2014-2025 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 java.net.BindException;
import java.net.InetSocketAddress;

/**
 * Interface for managing ports in use by UdpChannelTransports.
 */
public interface PortManager
{
    /**
     * Called before an OS bind to adjust the bound address and to notify of the bind for the port manager.
     *
     * @param udpChannel  for the UDP endpoint being bound.
     * @param bindAddress for the bind.
     * @return InetSocketAddress to use for the bind.
     * @throws BindException if the bind should not be performed.
     */
    InetSocketAddress getManagedPort(
        UdpChannel udpChannel,
        InetSocketAddress bindAddress) throws BindException;

    /**
     * Called after the bound socket is to be closed.
     *
     * @param bindAddress used for the bind previously.
     */
    void freeManagedPort(InetSocketAddress bindAddress);
}