simple-messaging-lib v1.0.2

SimpleMessagingLib

GitHub-Repo: https://github.com/sebastianbrunnert/SimpleMessagingLib

This is a simple library which allows you to make messaging easy in your project. At the moment you can just use it in Java and JavaScript. You build up an UDP-Server to which multiple Clients can connect, send to them messages and receive messages from these Clients.

How to use - JavaScript

Actually, this library is simple to use, so i would recommend you to look at the example(s).
After integrating this library to your project you can:

Installing Library

$ npm install simple-messaging-lib

Startup Server

// Import the library (server)
const { createServer } =  require("simplemessaginglib/server")

// Creates server on port 4444
var server =  createServer(4444, function(packet,connection) {
	// This method is called when the server receives a packet
	// packet.title (String) 
	// packet.args (Map)
	// connection.address (String)
	// connection.port (int)	
});

Create a Client

// Import the library (client)
const { createClient } =  require("../client")

// Connects client to server on 127.0.0.1:4444
var client =  createClient("127.0.0.1",4444, function(packet) {
	// This method is called when the client receives a packet from the server
	// packet.title (String) 
	// packet.args (Map)
});

Sending a Messaging Packet from Server to Client

// @arg1 address (String)
// @arg2 port (int)
// @arg3 title (String)
// (optional) @arg4 args (Map<String, String>)
server.send(address,port,title,args);

Sending a Messaging Packet from Client to Server

// @arg1 title (String)
// (optional) @arg2 args (Map<String, String>)
client.send(title,args);

How to use - Java

Actually, this library is simple to use, so i would recommend you to look at the example(s). After integrating this library to your project you can:

Startup Server

MessengerServer messengerServer = new MessengerServer(4444) { // this creates the Server
    @Override
    public void onReceive(MessengerPacket messengerPacket, InetAddress inetAddress, int port) { // this message gets triggered when receiving data from a Client
        
    }
};
messengerServer.start(); // this actually starts the Server

Creating a Client

MessengerClient messengerClient = new MessengerClient("127.0.0.1", 4444) { // this creates a Client
    @Override
    public void onReceive(MessengerPacket messengerPacket) { // this message gets triggered when receiving data from a Server

    }
};
messengerClient.connect(); // this actually starts the Client

Creating a Messaging Packet

HashMap<String,String> args = new HashMap<>(); // this map represents the arguments that will be send
args.put("testArg","testKey") // use the HashMap just as known
try {
    MessengerPacket messengerPacket = new MessengerPacket("Title of the Packet", args); // creating the actuall packet
} catch (MessengerPacketContainsSplitterException e) {
    e.printStackTrace();
}

Sending a Messaging Packet from Client to Server

// @arg1 messengerPacket (MessengerPacket)
messengerClient.send(messengerPacket);

Sending a Messaging Packet from Server to Client

// @arg1 messengerPacket (MessengerPacket)
// @arg2 inetAdress (InetAdress)
// @arg3 port (int)
messengerSever.send(messengerPacket,inetAddress,port)

// you can get the InetAdress and the port from the abstract function
onReceive(MessengerPacket messengerPacket, InetAddress inetAddress, int port)
// look at the example to see concret uses of this technique

Todo

• Broadcast Function
• Other Languages
• More examples
• Publish Maven-Repository

Warning

No encryption implemented!