AFUNIXSocketPair.java

/*
 * 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 java.io.IOException;
import java.nio.channels.DatagramChannel;

/**
 * A pair of sockets.
 *
 * @param <T> The socket type.
 * @author Christian Kohlschütter
 */
public final class AFUNIXSocketPair<T extends AFSomeSocket> extends AFSocketPair<T> {
  AFUNIXSocketPair(T socket1, T socket2) {
    super(socket1, socket2);
  }

  /**
   * Opens a socket pair of interconnected channels.
   *
   * @return The new channel pair.
   * @throws IOException on error.
   */
  public static AFUNIXSocketPair<AFUNIXSocketChannel> open() throws IOException {
    return AFUNIXSelectorProvider.provider().openSocketChannelPair();
  }

  /**
   * Opens a socket pair of interconnected datagram channels.
   *
   * @return The new channel pair.
   * @throws IOException on error.
   */
  public static AFUNIXSocketPair<AFUNIXDatagramChannel> openDatagram() throws IOException {
    return AFUNIXSelectorProvider.provider().openDatagramChannelPair();
  }

  /**
   * Opens a socket pair of interconnected {@link DatagramChannel}s, using the given socket type.
   *
   * @param type The socket type.
   * @return The new channel pair.
   * @throws IOException on error.
   */
  public static AFUNIXSocketPair<AFUNIXDatagramChannel> openDatagram(AFSocketType type)
      throws IOException {
    return AFUNIXSelectorProvider.provider().openDatagramChannelPair(type);
  }
}