View Javadoc

    1   /*
    2    *  Licensed to the Apache Software Foundation (ASF) under one
    3    *  or more contributor license agreements.  See the NOTICE file
    4    *  distributed with this work for additional information
    5    *  regarding copyright ownership.  The ASF licenses this file
    6    *  to you under the Apache License, Version 2.0 (the
    7    *  "License"); you may not use this file except in compliance
    8    *  with the License.  You may obtain a copy of the License at
    9    *
    10   *    http://www.apache.org/licenses/LICENSE-2.0
    11   *
    12   *  Unless required by applicable law or agreed to in writing,
    13   *  software distributed under the License is distributed on an
    14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    15   *  KIND, either express or implied.  See the License for the
    16   *  specific language governing permissions and limitations
    17   *  under the License.
    18   *
    19   */
    20  package org.apache.mina.transport.socket;
    21
    22  import java.net.DatagramSocket;
    23  import java.net.PortUnreachableException;
    24
    25  import org.apache.mina.core.session.IoSessionConfig;
    26
    27  /**
    28   * An {@link IoSessionConfig} for datagram transport type.
    29   *
    30   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    31   */
    32  public interface DatagramSessionConfig extends IoSessionConfig {
    33      /**
    34       * @see DatagramSocket#getBroadcast()
    35       */
    36      boolean isBroadcast();
    37
    38      /**
    39       * @see DatagramSocket#setBroadcast(boolean)
    40       */
    41      void setBroadcast(boolean broadcast);
    42
    43      /**
    44       * @see DatagramSocket#getReuseAddress()
    45       */
    46      boolean isReuseAddress();
    47
    48      /**
    49       * @see DatagramSocket#setReuseAddress(boolean)
    50       */
    51      void setReuseAddress(boolean reuseAddress);
    52
    53      /**
    54       * @see DatagramSocket#getReceiveBufferSize()
    55       */
    56      int getReceiveBufferSize();
    57
    58      /**
    59       * @see DatagramSocket#setReceiveBufferSize(int)
    60       */
    61      void setReceiveBufferSize(int receiveBufferSize);
    62
    63      /**
    64       * @see DatagramSocket#getSendBufferSize()
    65       */
    66      int getSendBufferSize();
    67
    68      /**
    69       * @see DatagramSocket#setSendBufferSize(int)
    70       */
    71      void setSendBufferSize(int sendBufferSize);
    72
    73      /**
    74       * @see DatagramSocket#getTrafficClass()
    75       */
    76      int getTrafficClass();
    77
    78      /**
    79       * @see DatagramSocket#setTrafficClass(int)
    80       */
    81      void setTrafficClass(int trafficClass);
    82
    83      /**
    84       * If method returns true, it means session should be closed when a
    85       * {@link PortUnreachableException} occurs.
    86       */
    87      boolean isCloseOnPortUnreachable();
    88
    89      /**
    90       * Sets if the session should be closed if an {@link PortUnreachableException}
    91       * occurs.
    92       */
    93      void setCloseOnPortUnreachable(boolean closeOnPortUnreachable);
    94  }