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.core.service;
    21
    22  import java.net.SocketAddress;
    23  import java.util.Set;
    24
    25  import org.apache.mina.core.session.IoSession;
    26  import org.apache.mina.core.session.IoSessionConfig;
    27
    28  /**
    29   * Provides meta-information that describes an {@link IoService}.
    30   *
    31   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    32   */
    33  public interface TransportMetadata {
    34
    35      /**
    36       * Returns the name of the service provider (e.g. "nio", "apr" and "rxtx").
    37       */
    38      String getProviderName();
    39
    40      /**
    41       * Returns the name of the service.
    42       */
    43      String getName();
    44
    45      /**
    46       * Returns <code>true</code> if the session of this transport type is
    47       * <a href="http://en.wikipedia.org/wiki/Connectionless">connectionless</a>.
    48       */
    49      boolean isConnectionless();
    50
    51      /**
    52       * Returns {@code true} if the messages exchanged by the service can be
    53       * <a href="http://en.wikipedia.org/wiki/IPv4#Fragmentation_and_reassembly">fragmented
    54       * or reassembled</a> by its underlying transport.
    55       */
    56      boolean hasFragmentation();
    57
    58      /**
    59       * Returns the address type of the service.
    60       */
    61      Class<? extends SocketAddress> getAddressType();
    62
    63      /**
    64       * Returns the set of the allowed message type when you write to an
    65       * {@link IoSession} that is managed by the service.
    66       */
    67      Set<Class<? extends Object>> getEnvelopeTypes();
    68
    69      /**
    70       * Returns the type of the {@link IoSessionConfig} of the service
    71       */
    72      Class<? extends IoSessionConfig> getSessionConfigType();
    73  }