johnnyapol / libgdx-udp-extension Goto Github PK

I'm having problems running the tests.Any help?

The library should include support for a P2P system that supports cross-platform match creation and discovery on a local network.

First, I realize this project is 3 years old and I also appreciate what you're doing here, so take these comments as constructive criticism. I was going to try this API, but I found too much inaccuracy in the documentation and API.

• I've noticed some of your methods have inconsistent implementations. For example, look at the methods in class Packet. Some of them check for null on the input, others have side effects like calling close on input streams, others do not. Why?
• Why do your methods (e.g. readDouble) return boxed types like Double when the underlying DataInputStream actually returns unboxed primitives?
• Why do you refer to member objects with this alternatively within methods? Have a look at readDatagram, which doesn't at first and then does.
• Your class UDPManager is arguably misnamed, as it isn't a UDP Manager at all. If anything, it's a single UDP socket manager, but it's hardly that. It's a place for the user to implement, so by java standards it's really a UDPFactory.

In the documentation, I take issue with improper reasons listed for throwing exceptions. For example, Packet::createDatagram claims to throw an IOException:

@throws IOException If there was an error retrieving the data */

But why is a method dedicated to creating datagrams doing any "retrieving of data"? If you look at the implementation, it actually isn't. It's calling flush on a DataOutputStream, so if anything, it's writing data.

I suggest you carefully review this file, as it contains many such inaccuracies which are confusing for someone trying to use this API.

The port parameter is listed as The port of the server you want to connect to, in reality this should probably be a different port, otherwise both client and server cannot run on the same machine.

The server port should be provided as part of a datagram sent through the client.