View Javadoc
1   /*
2    * Copyright 2015 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.unix;
17  
18  import io.netty.buffer.ByteBufAllocator;
19  import io.netty.channel.ChannelConfig;
20  import io.netty.channel.MessageSizeEstimator;
21  import io.netty.channel.RecvByteBufAllocator;
22  
23  /**
24   * Special {@link ChannelConfig} for {@link DomainSocketChannel}s.
25   */
26  public interface DomainSocketChannelConfig extends ChannelConfig {
27  
28      @Override
29      DomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);
30  
31      @Override
32      DomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis);
33  
34      @Override
35      DomainSocketChannelConfig setWriteSpinCount(int writeSpinCount);
36  
37      @Override
38      DomainSocketChannelConfig setAllocator(ByteBufAllocator allocator);
39  
40      @Override
41      DomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator);
42  
43      @Override
44      DomainSocketChannelConfig setAutoRead(boolean autoRead);
45  
46      @Override
47      DomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);
48  
49      @Override
50      DomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);
51  
52      @Override
53      DomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator);
54  
55      /**
56       * Change the {@link DomainSocketReadMode} for the channel. The default is
57       * {@link DomainSocketReadMode#BYTES} which means bytes will be read from the
58       * {@link io.netty.channel.Channel} and passed through the pipeline. If
59       * {@link DomainSocketReadMode#FILE_DESCRIPTORS} is used
60       * {@link FileDescriptor}s will be passed through the {@link io.netty.channel.ChannelPipeline}.
61       *
62       * This setting can be modified on the fly if needed.
63       */
64      DomainSocketChannelConfig setReadMode(DomainSocketReadMode mode);
65  
66      /**
67       * Return the {@link DomainSocketReadMode} for the channel.
68       */
69      DomainSocketReadMode getReadMode();
70  }