blob: a5c52b3c034e575452c8486385ef9a3d92233d22 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/*
* SocketProcessor.java February 2001
*
* Copyright (C) 2001, Niall Gallagher <niallg@users.sf.net>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package org.simpleframework.transport;
import java.io.IOException;
/**
* The <code>SocketProcessor</code> interface represents a processor that
* is used to accept <code>Socket</code> objects. Implementations of
* this object will typically hand the socket over for processing either
* by some form of protocol handler or message processor. If the socket
* contains an <code>SSLEngine</code> an SSL hand shake may be performed
* before any messages on the socket are interpreted.
*
* @author Niall Gallagher
*
* @see org.simpleframework.transport.connect.SocketConnection
*/
public interface SocketProcessor {
/**
* Used to process the <code>Socket</code> which is a full duplex
* TCP connection to a higher layer the application. It is this
* layer that is responsible for interpreting a protocol or handling
* messages in some manner. In the case of HTTP this will initiate
* the consumption of a HTTP request after any SSL handshake is
* finished if the connection is secure.
*
* @param socket this is the connected HTTP socket to process
*/
void process(Socket socket) throws IOException;
/**
* This method is used to stop the <code>SocketProcessor</code> such
* that it will accept no more sockets. Stopping the server ensures
* that all resources occupied will be released. This is required
* so that all threads are stopped, and all memory is released.
* <p>
* Typically this method is called once all connections to the
* server have been stopped. As a final act of shutting down the
* entire server all threads must be stopped, this allows collection
* of unused memory and the closing of file and socket resources.
*/
void stop() throws IOException;
}
|
