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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
* %CopyrightBegin%
*
* Copyright Ericsson AB 2015. All Rights Reserved.
*
* The contents of this file are subject to the Erlang Public License,
* Version 1.1, (the "License"); you may not use this file except in
* compliance with the License. You should have received a copy of the
* Erlang Public License along with this software. If not, it can be
* retrieved online at http://www.erlang.org/.
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* %CopyrightEnd%
*/
package com.ericsson.otp.erlang;
import java.io.IOException;
import java.net.InetAddress;
/**
* Factory class used to create client- and server-side transport instances. One
* static instance of class implementing this interface is created when program
* loaded. Default implementation used is {@link OtpSocketTransportFactory}.
* JInterface user can specify custom transport factory implementing this
* interface in the following ways:
* <dl>
* <dt>defining static class as internal to class holding main() method</dt>
* <dd>In the systems, where main class can be retrieved with
* <code>System.getProperty("sun.java.command")</code>, user can define static
* class <b>OtpErlangSystemTuner</b> internal to the main class, providing at
* least one static method with the name <b>getOtpTransportFactory</b>, with no
* parameters, returning object of class implementing
* <b>OtpTransportFactory</b>, for example:
*
* <pre>
*
* public class MyMainClass {
*
* public static class OtpErlangSystemTuner {
* ...
* public static OtpTransportFactory getOtpTransportFactory() {
* return new MyTransportFactory();
* }
* }
*
* public static class MyTransportFactory implements OtpTransportFactory {
* ...
* }
*
* public static void main(String[] args) {
* ...
* }
* }
*
*
* </pre>
*
* </dd>
*
* <dt>specifying factory class in the system properties</dt>
* <dd>User-defined transport factory class may be specified via system property
* <b>OtpTransportFactory</b>, for example:
*
* <pre>
*
* package com.my.company;
*
* public static class MyTransportFactory implements OtpTransportFactory {
* ...
* }
* </pre>
*
* In such case program may be run with
* -DOtpTransportFactory=com.my.company.MyTransportFactory, or other way of
* setting system property <i>before execution of static initializers</i> may be
* used.</dd>
* </dl>
*
* @author Dmitriy Kargapolov
*/
public interface OtpTransportFactory {
/**
* Create instance of {@link OtpTransport}
*
* @param addr
* host name or IP address string
* @param port
* port number
* @return new socket object
* @throws IOException
*/
public abstract OtpTransport createTransport(String addr, int port)
throws IOException;
/**
* Create instance of {@link OtpTransport}
*
* @param addr
* peer address
* @param port
* port number
* @return new socket object
* @throws IOException
*/
public abstract OtpTransport createTransport(InetAddress addr, int port)
throws IOException;
/**
* Create instance of {@link OtpServerTransport}
*
* @param port
* port number to listen on
* @return new socket object
* @throws IOException
*/
public OtpServerTransport createServerTransport(int port)
throws IOException;
}
|
