sigonasr2/jmonkeyengine
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Deprecated some more things, fixed some javadoc links,

Browse Source 
and added some more package.html files.


git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@7017 75d07b2b-3a1a-0410-a2c5-0572b91ccdca
This commit is contained in:
PSp..om 2011-03-18 00:21:45 +00:00
parent d1c8626419
commit 43cb19c934
8 changed files with 48 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
engine/src/networking/com/jme3/network/base/package.html Normal file
View File

@ -0,0 +1,8 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<body>
The base package contains the default implementations for the
{@link com.jme3.network.Client} and {@link com.jme3.network.Server}
interfaces from the public API.
</body>
</html>

8
engine/src/networking/com/jme3/network/connection/Client.java
View File

@ -54,6 +54,10 @@ import java.util.List;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/**
* @deprecated Use {@link com.jme3.network.Client} from {@link com.jme3.network.Network} instead.
*/
@Deprecated
public class Client extends ServiceManager { public class Client extends ServiceManager {
protected Logger log = Logger.getLogger(Client.class.getName()); protected Logger log = Logger.getLogger(Client.class.getName());
@ -83,7 +87,9 @@ public class Client extends ServiceManager {
/** /**
* Constructs this client. * Constructs this client.
* @deprecated Call createClient() on {@link com.jme3.network.Network} instead.
*/ */
@Deprecated
public Client() { public Client() {
this(false); this(false);
} }
@ -174,7 +180,9 @@ public class Client extends ServiceManager {
* @param tcpPort The TCP port to use. * @param tcpPort The TCP port to use.
* @param udpPort The UDP port to use. * @param udpPort The UDP port to use.
* @throws IOException When a connection error occurs. * @throws IOException When a connection error occurs.
* @deprecated Call connectToServer() on {@link com.jme3.network.Network} instead.
*/ */
@Deprecated
public Client(String ip, int tcpPort, int udpPort) throws IOException { public Client(String ip, int tcpPort, int udpPort) throws IOException {
this(); this();

4
engine/src/networking/com/jme3/network/connection/Server.java
View File

@ -55,7 +55,9 @@ import java.util.logging.Logger;
* no arg constructor, and then call bind later on. * no arg constructor, and then call bind later on.
* *
* @author Lars Wesselius * @author Lars Wesselius
* @deprecated Use {@link com.jme3.network.Server} from {@link com.jme3.network.Network} instead.
*/ */
@Deprecated
public class Server extends ServiceManager { public class Server extends ServiceManager {
protected Logger log = Logger.getLogger(Server.class.getName()); protected Logger log = Logger.getLogger(Server.class.getName());
@ -154,7 +156,9 @@ public class Server extends ServiceManager {
* @param tcpPort The TCP port to use. * @param tcpPort The TCP port to use.
* @param udpPort The UDP port to use. * @param udpPort The UDP port to use.
* @throws IOException When a binding error occurs. * @throws IOException When a binding error occurs.
* @deprecated Call createServer() on {@link com.jme3.network.Network} instead.
*/ */
@Deprecated
public Server(int tcpPort, int udpPort) throws IOException { public Server(int tcpPort, int udpPort) throws IOException {
this(); this();

2
engine/src/networking/com/jme3/network/events/ConnectionListener.java
View File

@ -38,7 +38,9 @@ import com.jme3.network.connection.Client;
* Listener for server events. * Listener for server events.
* *
* @author Lars Wesselius * @author Lars Wesselius
* @deprecated Use {@link com.jme3.network.ConnectionListener} instead.
*/ */
@Deprecated
public interface ConnectionListener { public interface ConnectionListener {
public void clientConnected(Client client); public void clientConnected(Client client);
public void clientDisconnected(Client client); public void clientDisconnected(Client client);

2
engine/src/networking/com/jme3/network/events/MessageListener.java
View File

@ -38,7 +38,9 @@ import com.jme3.network.message.Message;
* Listener for messages. * Listener for messages.
* *
* @author Lars Wesselius * @author Lars Wesselius
* @deprecated Use {@link com.jme3.network.MessageListener} instead.
*/ */
@Deprecated
public interface MessageListener { public interface MessageListener {
public void messageReceived(Message message); public void messageReceived(Message message);
public void messageSent(Message message); public void messageSent(Message message);

14
engine/src/networking/com/jme3/network/kernel/package.html
View File

@ -8,19 +8,19 @@ have to deal with these classes unless they are writing their own
client and server implementations that diverge from the standard client and server implementations that diverge from the standard
classes that are provided. classes that are provided.
<p>{@link Kernel} defines the core of a server-side message <p>{@link com.jme3.network.kernel.Kernel} defines the core of a server-side message
broker that abstracts away the specific transport and underlying broker that abstracts away the specific transport and underlying
threading model used. For example, it might use NIO selectors threading model used. For example, it might use NIO selectors
in a single threaded model or straight multithreaded socket in a single threaded model or straight multithreaded socket
model. Or it might implement SSL connections. Once created, model. Or it might implement SSL connections. Once created,
{@link Kernel} users don't need to care about the details.</p> {@link com.jme3.network.kernel.Kernel} users don't need to care about the details.</p>
<p>{@link Endpoint} is a managed connection within a {@link Kernel} <p>{@link com.jme3.network.kernel.Endpoint} is a managed connection within a
providing kernel to client connectivity.</p> {@link com.jme3.network.kernel.Kernel} providing kernel to client connectivity.</p>
<p>{@link Connector} defines the basic client-side message sender <p>{@link com.jme3.network.kernel.Connector} defines the basic client-side message sender
and these objects are typically used to connect to a {@link Kernel} though and these objects are typically used to connect to a {@link com.jme3.network.kernel.Kernel}
they can connect to any network port that supports the implementation's though they can connect to any network port that supports the implementation's
protocol. Implementations are provided for straight TCP and UDP communication protocol. Implementations are provided for straight TCP and UDP communication
and could be extended to support SSL or different threading models.</p> and could be extended to support SSL or different threading models.</p>

6
engine/src/networking/com/jme3/network/message/Message.java
View File

@ -65,6 +65,9 @@ public class Message implements com.jme3.network.Message {
return this; return this;
} }
/**
* @deprecated This method always returns null in the new API.
*/
@Deprecated @Deprecated
public Client getClient() { public Client getClient() {
return connector; return connector;
@ -75,6 +78,9 @@ public class Message implements com.jme3.network.Message {
this.connector = connector; this.connector = connector;
} }
/**
* @deprecated This method always returns null in the new API.
*/
@Deprecated @Deprecated
public Connection getConnection() { public Connection getConnection() {
return connection; return connection;

11
engine/src/networking/com/jme3/network/package.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<body>
The network package contains the public API for the jME3
SpiderMonkey networking module. The {@link com.jme3.network.Network}
class is the entry point for creating default implementations
of {@link com.jme3.network.Client} and {@link com.jme3.network.Server}
implementations.
</body>
</html>