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.filter.keepalive;
21  
22  import org.apache.mina.core.session.IoSession;
23  
24  /**
25   * Provides keep-alive messages to {@link KeepAliveFilter}.
26   *  
27   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
28   */
29  public interface KeepAliveMessageFactory {
30  
31      /**
32       * Returns <tt>true</tt> if and only if the specified message is a
33       * keep-alive request message.
34       */
35      boolean isRequest(IoSession session, Object message);
36  
37      /**
38       * Returns <tt>true</tt> if and only if the specified message is a 
39       * keep-alive response message;
40       */
41      boolean isResponse(IoSession session, Object message);
42  
43      /**
44       * Returns a (new) keep-alive request message.
45       * Returns <tt>null</tt> if no request is required.
46       */
47      Object getRequest(IoSession session);
48  
49      /**
50       * Returns a (new) response message for the specified keep-alive request.
51       * Returns <tt>null</tt> if no response is required.
52       */
53      Object getResponse(IoSession session, Object request);
54  }