Java Socket setSoLinger() method

The setSoLinger() method of Java Socket class enables or disables the SO_LINGER option with the given linger time in seconds. It is used to specify how the close() method affects socket using a connection-oriented protocol. The timeout value is platform-specific, and this setting only affects the socket close.

Syntax

Parameter

on - whether the 'linger' should be enabled or not.M

linger - how long to linger for, if the parameter 'on' is true.

Return

Throws

SocketException - if an error is there in the underlying protocol, such as a TCP error.

IllegalArgumentException - if the linger value is less than 0.

Example 1

import java.io.IOException;
import java.net.*;
public class JavaSocketSetSoLingerExample1  {
    public static void main(String[] args) throws IOException {
        //calling the constructor of the socket class
        Socket socket = new Socket();
        //enabling the SO_LINGER option
        boolean on=true;
        //setting the integer value for timeout
        int timeout=90;
        //setSoLinger() method enables or disables the SO_LINGER  option with the given linger time in seconds.
        socket.setSoLinger(on,timeout);
        //getSoLinger() method returns the setting if the SO_Linger option is set
        System.out.println("Timeout value: "+socket.getSoLinger());
    }
}

Test it Now

Output:

Timeout value: 90

Example 2

import java.io.IOException;
import java.net.*;
public class JavaSocketSetSoLingerExample2  {
    public static void main(String[] args) throws IOException {
        //calling the constructor of the socket class
        Socket socket = new Socket();
        //disabling the SO_LINGER option
        boolean on=false;
        //setting the integer value for timeout
        int timeout=90;
        //setSoLinger() method enables or disables the SO_LINGER  option with the given linger time in seconds.
        //if the SO_LINGER option is disabled, it returns -1
        socket.setSoLinger(on,timeout);
        //getSoLinger() method returns the setting if the SO_Linger option is set
        System.out.println("Timeout value: "+socket.getSoLinger());
    }
}

Test it Now

Output:

Timeout value: -1

Example 3

import java.io.IOException;
import java.net.*;
public class JavaSocketSetSoLingerExample3  {
    public static void main(String[] args) throws IOException {
        //calling the constructor of the socket class
        Socket socket = new Socket();
        //disabling the SO_LINGER option
        boolean on=true;
        //setting the integer value for timeout
        //the timeout value should be greater or equal to 0
        int timeout=-10;
        socket.setSoLinger(on,timeout);
        //getSoLinger() method returns the setting if the SO_Linger option is set
        System.out.println("Send Buffer size: "+socket.getSoLinger());
    }
}

Test it Now

Output:

Exception in thread "main" java.lang.IllegalArgumentException: invalid value for SO_LINGER
	at java.net.Socket.setSoLinger(Socket.java:1021)
	at com.javaTpoint.JavaSocketSetSoLingerExample3.main(JavaSocketSetSoLingerExample3.java:14)

Example 4

import java.io.IOException;
import java.net.*;
public class JavaSocketSetSoLingerExample4  {
    public static void main(String[] args) throws IOException {
        //calling the constructor of the socket class
        Socket socket = new Socket();
        //closing the socket
        socket.close();
        //disabling the SO_LINGER option
        boolean on=true;
        //setting the integer value for timeout
        //the timeout value should be greater or equal to 0
        int timeout=10;
        //setSoLinger() method enables or disables the SO_LINGER  option with the given linger time in seconds.
        //it will throw an error, as the socket is already closed
        socket.setSoLinger(on,timeout);
        //getSoLinger() method returns the setting if the SO_Linger option is set
        System.out.println("Send Buffer size: "+socket.getSoLinger());
    }
}

Test it Now

Output:

Exception in thread "main" java.net.SocketException: Socket is closed
	at java.net.Socket.setSoLinger(Socket.java:1016)
	at com.javaTpoint.JavaSocketSetSoLingerExample4.main(JavaSocketSetSoLingerExample4.java:18)

Next TopicJava Socket Class

← prev next →