junixsocket logo

Users of junixsocket are strongly advised to upgrade to version 2.10.1 or newer (changelog)

junixsocket

junixsocket is a Java/JNI library that allows the use of
Unix Domain Sockets (AF_UNIX sockets), and
other address/protocol families (such as AF_TIPC, AF_VSOCK, and AF_SYSTEM),
from Java.

Unix sockets API, in Java, AF.

junixsocket is the most complete implementation of AF_UNIX sockets for the Java ecosystem.
Supports other socket types, such as TIPC (on Linux), VSOCK (on Linux, and certain macOS VMs), and
AF_SYSTEM (on macOS) as well!
Comes with pre-built native libraries for most operating systems and platforms, including
macOS, Linux, Android, Windows, Solaris, FreeBSD, NetBSD, OpenBSD, DragonFlyBSD, AIX, IBM i.
Additionally, you can build and run junixsocket natively on IBM z/OS (experimental).
Supports all Java versions since Java 8* (with common AF_UNIX support available for Java 7 and newer)
Supports both the Java Socket API and NIO (java.net.Socket, java.net.SocketChannel, etc.)
Supports streams and datagrams.
Supports Remote Method Invocation (RMI) over AF_UNIX.
Supports JDBC database connectors (connect to a local database server via Unix sockets).
- Generic AFUNIXSocketFactory for databases like PostgreSQL
- Custom socket factory for MySQL Connector/J, as recommended by Oracle
Supports peer credentials.
Supports sending and receiving file descriptors.
Supports the abstract namespace on Linux.
Supports socketpair, and instantiating socket classes from file descriptors.
Supports HTTP over UNIX sockets (using NanoHTTPD, OkHttp, and jetty).
Supports JPMS/Jigsaw modules. The project is modularized so you can install only what you need.
Supports GraalVM native-image AOT/ahead-of-time compilation (since 2.6.0)
Provides a selftest package with 300+ tests to ensure compatibility with any target platform.
No outside dependencies are necessary at runtime.
Apache 2.0 licensed.

* (Tested up to Java 24; basic support for Java 7 was dropped in version 2.5.0 and reintroduced in version 2.8.0).

Quick links

Project website and Github project
Changelog
Getting started
Demo code (Java source)
- Sockets (org.newsclub.net.unix.demo)
- RMI over Unix Sockets (org.newsclub.net.unix.demo.rmi and org.newsclub.net.unix.demo.rmi.services)
- MySQL over Unix Sockets (org.newsclub.net.mysql.demo)
- Postgres over Unix Sockets (org.newsclub.net.unix.demo.jdbc)
- Apache Mina (org.newsclub.net.unix.demo.mina)
- NanoHttpd (org.newsclub.net.unix.demo.nanohttpd)
- Netty (org.newsclub.net.unix.demo.netty)
- OkHttp (org.newsclub.net.unix.demo.okhttp)
- SSL (org.newsclub.net.unix.demo.ssl)
API Javadocs
Unix Domain Socket Reference
TIPC documentation
VSOCK documentation
AF_SYSTEM documentation

Licensing

junixsocket is released under the Apache 2.0 License.

Commercial support is available through Kohlschütter Search Intelligence.

Self-test

To verify that the software works as expected on your platform, you can run the
junixsocket-selftest program, which is
located in the "junixsocket-dist" distribution package, and also released on GitHub.

java -jar junixsocket-selftest-VERSION-jar-with-dependencies.jar

(with VERSION being the corresponding junixsocket version).

Maven dependency

To include the core junixsocket functionality in your project, add the following Maven dependency

NOTE Since version 2.4.0, junixsocket-core is POM-only (that's why you need to specify
<type>pom</type>)

<dependency>
  <groupId>com.kohlschutter.junixsocket</groupId>
  <artifactId>junixsocket-core</artifactId>
  <version>2.10.1</version>
  <type>pom</type>
</dependency>

While you should definitely pin your dependency to a specific version, you are very much encouraged
to keep updating to the most recent version. Check back frequently.

For more, optional packages (RMI, MySQL, Jetty, TIPC, VSOCK, server, Darwin, SSL, GraalVM, etc.) and
Gradle instructions see here

Snapshot builds for testing

When you're testing a -SNAPSHOT version, make sure that the Sonatype snapshot repository is
enabled in your POM:

<repositories>
    <repository>
        <id>sonatype.snapshots</id>
        <name>Sonatype snapshot repository</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        <layout>default</layout>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

To update to the latest SNAPSHOT (which is currently not being built for every commit),
run the following command from within your own project:

mvn -U dependency:resolve

or (for Gradle)

./gradlew refreshVersions

Junixsocket