View Javadoc
1   /*
2    * Copyright 2011 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.channel.sctp;
17  
18  import com.sun.nio.sctp.SctpStandardSocketOptions.InitMaxStreams;
19  import io.netty.buffer.ByteBufAllocator;
20  import io.netty.channel.ChannelConfig;
21  import io.netty.channel.MessageSizeEstimator;
22  import io.netty.channel.RecvByteBufAllocator;
23  
24  /**
25   * A {@link ChannelConfig} for a {@link SctpServerChannelConfig}.
26   * <p/>
27   * <h3>Available options</h3>
28   * <p/>
29   * In addition to the options provided by {@link ChannelConfig},
30   * {@link SctpServerChannelConfig} allows the following options in the
31   * option map:
32   * <p/>
33   * <table border="1" cellspacing="0" cellpadding="6">
34   * <tr>
35   * <th>Name</th><th>Associated setter method</th>
36   * </tr><tr>
37   * <td>{@link SctpChannelOption#SO_BACKLOG}</td><td>{@link #setBacklog(int)}</td>
38   * </tr><tr>
39   * <td>{@link SctpChannelOption#SO_RCVBUF}</td><td>{@link #setReceiveBufferSize(int)}</td>
40   * </tr><tr>
41   * <td>{@link SctpChannelOption#SO_SNDBUF}</td><td>{@link #setSendBufferSize(int)}</td>
42   * </tr><tr>
43   * <td>{@link SctpChannelOption#SCTP_INIT_MAXSTREAMS}</td><td>{@link #setInitMaxStreams(InitMaxStreams)}</td>
44   * </tr>
45   * </table>
46   */
47  public interface SctpServerChannelConfig extends ChannelConfig {
48  
49      /**
50       * Gets the backlog value to specify when the channel binds to a local address.
51       */
52      int getBacklog();
53  
54      /**
55       * Sets the backlog value to specify when the channel binds to a local address.
56       */
57      SctpServerChannelConfig setBacklog(int backlog);
58  
59      /**
60       * Gets the <a href="http://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
61       *     {@code SO_SNDBUF}</a> option.
62       */
63      int getSendBufferSize();
64  
65      /**
66       * Sets the <a href="http://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
67       *     {@code SO_SNDBUF}</a> option.
68       */
69      SctpServerChannelConfig setSendBufferSize(int sendBufferSize);
70  
71      /**
72       * Gets the <a href="http://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
73       *     {@code SO_RCVBUF}</a> option.
74       */
75      int getReceiveBufferSize();
76  
77      /**
78       * Gets the <a href="http://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
79       *     {@code SO_RCVBUF}</a> option.
80       */
81      SctpServerChannelConfig setReceiveBufferSize(int receiveBufferSize);
82  
83      /**
84       * Gets the <a href="http://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
85       *     {@code SCTP_INIT_MAXSTREAMS}</a> option.
86       */
87      InitMaxStreams getInitMaxStreams();
88  
89      /**
90       * Gets the <a href="http://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
91       *     {@code SCTP_INIT_MAXSTREAMS}</a> option.
92       */
93      SctpServerChannelConfig setInitMaxStreams(InitMaxStreams initMaxStreams);
94  
95      @Override
96      SctpServerChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);
97  
98      @Override
99      SctpServerChannelConfig setWriteSpinCount(int writeSpinCount);
100 
101     @Override
102     SctpServerChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis);
103 
104     @Override
105     SctpServerChannelConfig setAllocator(ByteBufAllocator allocator);
106 
107     @Override
108     SctpServerChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator);
109 
110     @Override
111     SctpServerChannelConfig setAutoRead(boolean autoRead);
112 
113     @Override
114     SctpServerChannelConfig setAutoClose(boolean autoClose);
115 
116     @Override
117     SctpServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);
118 
119     @Override
120     SctpServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);
121 
122     @Override
123     SctpServerChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator);
124 }