org.newsclub.net.unix.AFServerSocketChannel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junixsocket-common Show documentation
junixsocket is a Java/JNI library that allows the use of Unix Domain Sockets (AF_UNIX sockets) and other socket types, such as AF_TIPC and AF_VSOCK, from Java, using the standard Socket API
The newest version!
/*
 * junixsocket
 *
 * Copyright 2009-2024 Christian Kohlschütter
 *
 * 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 org.newsclub.net.unix;

import static java.util.Objects.requireNonNull;

import java.io.FileDescriptor;
import java.io.IOException;
import java.net.ProtocolFamily;
import java.net.ServerSocket;
import java.net.SocketAddress;
import java.net.SocketOption;
import java.net.StandardProtocolFamily;
import java.nio.channels.ServerSocketChannel;
import java.nio.channels.spi.SelectorProvider;
import java.util.Objects;
import java.util.Set;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;

import com.kohlschutter.annotations.compiletime.SuppressFBWarnings;

/**
 * A selectable channel for stream-oriented listening sockets.
 *
 * @param  The concrete {@link AFSocketAddress} that is supported by this type.
 * @author Christian Kohlschütter
 */
public abstract class AFServerSocketChannel extends ServerSocketChannel
    implements FileDescriptorAccess, AFSomeSocketChannel {
  private final @NonNull AFServerSocket afSocket;

  /**
   * Creates a new {@link AFServerSocketChannel} instance.
   *
   * @param socket The corresponding {@link ServerSocket}.
   * @param sp The corresponding {@link SelectorProvider}.
   */
  @SuppressWarnings("all") // null
  protected AFServerSocketChannel(AFServerSocket socket, AFSelectorProvider sp) {
    super(sp);
    this.afSocket = Objects.requireNonNull(socket);
  }

  // CPD-OFF

  @SuppressWarnings("unchecked")
  @Override
  public  T getOption(SocketOption name) throws IOException {
    if (name instanceof AFSocketOption) {
      return getAFCore().getOption((AFSocketOption) name);
    }
    Integer optionId = SocketOptionsMapper.resolve(name);
    if (optionId == null) {
      throw new UnsupportedOperationException("unsupported option");
    } else {
      return (T) afSocket.getAFImpl().getOption(optionId);
    }
  }

  @Override
  public  AFServerSocketChannel setOption(SocketOption name, T value) throws IOException {
    if (name instanceof AFSocketOption) {
      getAFCore().setOption((AFSocketOption) name, value);
      return this;
    }
    Integer optionId = SocketOptionsMapper.resolve(name);
    if (optionId == null) {
      throw new UnsupportedOperationException("unsupported option");
    } else {
      afSocket.getAFImpl().setOption(optionId, value);
    }
    return this;
  }

  @Override
  public final Set> supportedOptions() {
    return SocketOptionsMapper.SUPPORTED_SOCKET_OPTIONS;
  }

  // CPD-ON

  @Override
  public final AFServerSocketChannel bind(SocketAddress local, int backlog) throws IOException {
    afSocket.bind(local, backlog);
    return this;
  }

  @SuppressFBWarnings("EI_EXPOSE_REP")
  @Override
  public final AFServerSocket socket() {
    return afSocket;
  }

  @Override
  public AFSocketChannel accept() throws IOException {
    boolean complete = false;
    Exception exception = null;
    try {
      begin();
      AFSocket socket = afSocket.accept1(false);
      complete = true;
      return socket == null ? null : socket.getChannel();
    } catch (IOException e) {
      throw InterruptibleChannelUtil.ioExceptionOrThrowRuntimeException( // NOPMD.PreserveStackTrace
          (exception = InterruptibleChannelUtil.handleException(this, e)));
    } finally {
      InterruptibleChannelUtil.endInterruptable(this, this::end, complete, exception);
    }
  }

  @Override
  public final @Nullable A getLocalAddress() {
    return getLocalSocketAddress();
  }

  @Override
  public final @Nullable A getLocalSocketAddress() {
    return afSocket.getLocalSocketAddress();
  }

  /**
   * Checks if the local socket address returned by {@link #getLocalAddress()} is still valid.
   *
   * The address is no longer valid if the server socket has been closed, {@code null}, or another
   * server socket has been bound on that address.
   *
   * @return {@code true} iff still valid.
   */
  public final boolean isLocalSocketAddressValid() {
    return afSocket.isLocalSocketAddressValid();
  }

  @Override
  protected final void implCloseSelectableChannel() throws IOException {
    afSocket.close();
  }

  @Override
  protected final void implConfigureBlocking(boolean block) throws IOException {
    getAFCore().implConfigureBlocking(block);
  }

  final AFSocketCore getAFCore() {
    return afSocket.getAFImpl().getCore();
  }

  @Override
  public final FileDescriptor getFileDescriptor() throws IOException {
    return afSocket.getFileDescriptor();
  }

  /**
   * Checks if this {@link AFServerSocketChannel}'s file should be removed upon {@link #close()}.
   *
   * Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract
   * namespace).
   *
   * @return {@code true} if an attempt is made to delete the socket file upon {@link #close()}.
   */
  public final boolean isDeleteOnClose() {
    return socket().isDeleteOnClose();
  }

  /**
   * Enables/disables deleting this {@link AFServerSocketChannel}'s file (or other resource type)
   * upon {@link #close()}.
   *
   * Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract
   * namespace).
   *
   * @param b Enabled if {@code true}.
   */
  public final void setDeleteOnClose(boolean b) {
    socket().setDeleteOnClose(b);
  }

  @Override
  public void setShutdownOnClose(boolean enabled) {
    socket().setShutdownOnClose(enabled);
  }

  /**
   * Opens a server-socket channel. The {@code family} parameter specifies the {@link ProtocolFamily
   * protocol family} of the channel's socket.
   * 
   * If the {@link ProtocolFamily} is of an {@link AFProtocolFamily}, or {@code UNIX}, the
   * corresponding junixsocket implementation is used. In all other cases, the call is delegated to
   * {@link ServerSocketChannel#open()}.
   *
   * @param family The protocol family.
   * @return The new {@link ServerSocketChannel}.
   * @throws IOException on error.
   */
  public static ServerSocketChannel open(ProtocolFamily family) throws IOException {
    requireNonNull(family);

    if (family instanceof AFProtocolFamily) {
      return ((AFProtocolFamily) family).openServerSocketChannel();
    } else if ("UNIX".equals(family.name())) {
      return AFUNIXServerSocketChannel.open();
    } else if (family instanceof StandardProtocolFamily) {
      return ServerSocketChannel.open();
    } else {
      throw new UnsupportedOperationException("Protocol family not supported");
    }
  }
}