Ballerina UDP Library

This library provides APIs for sending/receiving messages to/from another application process (local or remote) for connectionless protocols.

When the local host address or the IP address is not given to the optional localHost field, the localhost address is bound by default. The port number of the local port, which is used to connect to the remote server is determined randomly (ephemeral port).

Client

The udp:Client is used to interact with the remote UDP host and it can be defined as follows:

udp:Client socketClient = check new;

udp:Datagram datagram = {
    remoteHost: "localhost",
    remotePort : 48829,
    data : "Hello Ballerina".toBytes()
};

check socketClient->sendDatagram(datagram);

readonly & udp:Datagram result = check socketClient->receiveDatagram();

check socketClient->close();

ConnectClient

The udp:ConnectClient is configured by providing the remoteHost and remotePort so that it only receives data from and sends data to the configured remote host. Once connected, data may not be received from or sent to any other hosts. The client remains connected until it is explicitly closed. If the number of bytes given to the writeBytes method is greater than the data size allowed by a datagram, it will iteratively send all the bytes with several datagrams.

udp:ConnectClient socketClient = check new("localhost", 48829);

string msg = "Hello Ballerina";
check socketClient->writeBytes(msg.toBytes());

readonly & byte[] result = check socketClient->readBytes();

check socketClient->close();

Listener

The udp:Listener is used to listen to the incoming socket request.

The udp:Listener can have the following methods.

onBytes(readonly & byte[] data, udp:Caller caller) or onDatagram(readonly & udp:Datagram, udp:Caller): These remote methods get invoked once the content is received from the client. The client is represented using the udp:Caller.

onError(readonly & udp:Error err): This remote method is invoked in an error situation.

A udp:Listenercan be defined as follows:

service on new udp:Listener(48829) {
    remote function onDatagram(readonly & udp:Datagram datagram)
            returns udp:Datagram|udp:Error? {
        // Handle the content received from the client
    }

    remote function onError(udp:Error err) {
        // Handle the error situation
    }
}

Issues and projects

Issues and Projects tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc. please visit Ballerina Standard Library parent repository.

This repository only contains the source code for the package.

Building from the source

Setting up the prerequisites

Download and install Java SE Development Kit (JDK) version 17 (from one of the following locations).
- Oracle
- OpenJDK
  
  Note: Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

Building the source

Execute the commands below to build from the source.

To build the package:
```
./gradlew clean build
```
To run the tests:
```
./gradlew clean test
```

To run a group of tests

./gradlew clean test -Pgroups=<test_group_names>

To build the without the tests:
```
./gradlew clean build -x test
```
To debug package implementation:
```
./gradlew clean build -Pdebug=<port>
```

To debug with Ballerina language:

./gradlew clean build -PbalJavaDebug=<port>

Publish the generated artifacts to the local Ballerina central repository:
```
./gradlew clean build -PpublishToLocalCentral=true
```
Publish the generated artifacts to the Ballerina central repository:
```
./gradlew clean build -PpublishToCentral=true
```

Contributing to Ballerina

As an open source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

For more information go to the udp library.
For example demonstrations of the usage, go to Ballerina By Examples.
Chat live with us via our Discord server.
Post all technical questions on Stack Overflow with the #ballerina tag.

ballerina-platform/module-ballerina-udp

ballerina-platform

Reviews

Repository Details