All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.netty.channel.sctp.SctpChannel Maven / Gradle / Ivy

There is a newer version: 5.0.0.Alpha2
Show newest version
/*
 * Copyright 2011 The Netty Project
 *
 * The Netty Project licenses this file to you 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 io.netty.channel.sctp;

import com.sun.nio.sctp.Association;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelPromise;

import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.util.Set;

/**
 * A SCTP/IP  {@link Channel} interface for single SCTP association.
 *
 * 

* The SctpChannel is a message-oriented, connected transport which supports multi-streaming and multi-homing. *

*/ public interface SctpChannel extends Channel { @Override SctpServerChannel parent(); /** * Returns the underlying SCTP association. */ Association association(); /** * Return the (primary) local address of the SCTP channel. * * Please note that, this return the first local address in the underlying SCTP Channel's * local address iterator to support Netty Channel API. In other words, its the application's * responsibility to keep track of it's local primary address. * * (To set a local address as primary, the application can request by calling local SCTP stack, * with SctpStandardSocketOption.SCTP_PRIMARY_ADDR option). */ @Override InetSocketAddress localAddress(); /** * Return all local addresses of the SCTP channel. * Please note that, it will return more than one address if this channel is using multi-homing */ Set allLocalAddresses(); /** * Returns the {@link SctpChannelConfig} configuration of the channel. */ @Override SctpChannelConfig config(); /** * Return the (primary) remote address of the SCTP channel. * * Please note that, this return the first remote address in the underlying SCTP Channel's * remote address iterator to support Netty Channel API. In other words, its the application's * responsibility to keep track of it's peer's primary address. * * (The application can request it's remote peer to set a specific address as primary by * calling the local SCTP stack with SctpStandardSocketOption.SCTP_SET_PEER_PRIMARY_ADDR option) */ @Override InetSocketAddress remoteAddress(); /** * Return all remote addresses of the SCTP server channel. * Please note that, it will return more than one address if the remote is using multi-homing. */ Set allRemoteAddresses(); /** * Bind a address to the already bound channel to enable multi-homing. * The Channel bust be bound and yet to be connected. */ ChannelFuture bindAddress(InetAddress localAddress); /** * Bind a address to the already bound channel to enable multi-homing. * The Channel bust be bound and yet to be connected. * * Will notify the given {@link ChannelPromise} and return a {@link ChannelFuture} */ ChannelFuture bindAddress(InetAddress localAddress, ChannelPromise promise); /** * Unbind the address from channel's multi-homing address list. * The address should be added already in multi-homing address list. */ ChannelFuture unbindAddress(InetAddress localAddress); /** * Unbind the address from channel's multi-homing address list. * The address should be added already in multi-homing address list. * * Will notify the given {@link ChannelPromise} and return a {@link ChannelFuture} */ ChannelFuture unbindAddress(InetAddress localAddress, ChannelPromise promise); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy