Java - Socket setOOBInline() Method

---

---

Description

The Java Socket setOOBInline() enables/disables SO_OOBINLINE (receipt of TCP urgent data) By default, this option is disabled and TCP urgent data received on a socket is silently discarded. If the user wishes to receive urgent data, then this option must be enabled. When enabled, urgent data is received inline with normal data.

Declaration

Following is the declaration for java.net.Socket.setOOBInline() method.

public void setOOBInline(boolean on) throws SocketException

Parameters

on − true to enable SO_OOBINLINE, false to disable.

Return Value

NA

Exception

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

Example 1

The following example shows the usage of Java Socket setOOBInline() method to set the status of SO_OOBINLINE flag of socket instance. As first step, we've created a Socket instance using no argument constructor. Then in order to create a SocketAddress object, we've initialized an InetAddress instance of localhost address. Using InetSocketAddress object, we've created a SocketAddress object and then using bind() method, we bind the address to the socket. Then we're setting the SO_OOBINLINE flag as true using setOOBInline() method. Once done, we're printing the SO_OOBINLINE flag using getOOBInline() method, local port and inetaddress as shown. In the end, we closed the socket using close() method.

package com.tutorialspoint;

import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.Socket;
import java.net.SocketAddress;

public class SocketDemo {
   public static void main(String[] args) throws IOException {
      Socket socket = new Socket();  
      InetAddress inetAddress=InetAddress.getByName("localhost");  
      SocketAddress socketAddress=new InetSocketAddress(inetAddress, 6066);  
      socket.bind(socketAddress); 
      socket.setOOBInline(true); 
      System.out.println("Is SO_OOBINLINE: "+socket.getOOBInline()); 
      System.out.println("Port number: "+socket.getLocalPort()); 
      System.out.println("Inet Address: "+socket.getInetAddress()); 
      socket.close();
   }
}

Output

Let us compile and run the above program, this will produce the following result −

Is SO_OOBINLINE: true
Port number: 6066
Inet Address: null

Example 2

The following example shows the usage of Java Socket setOOBInline() method to set the status of SO_OOBINLINE flag of socket instance. As first step, we've created a Socket instance using no argument constructor. Now, we're printing the SO_OOBINLINE flag using getOOBInline() method. Then we're setting the SO_OOBINLINE flag as true using setOOBInline() method and print the same. In the end, we closed the socket using close() method.

package com.tutorialspoint;

import java.io.IOException;
import java.net.Socket;

public class SocketDemo {
   public static void main(String[] args) throws IOException {
      Socket socket = new Socket();  

      System.out.println("Is SO_OOBINLINE: "+socket.getOOBInline());
      socket.setOOBInline(true);  
      System.out.println("Is SO_OOBINLINE: "+socket.getOOBInline());
      socket.close();
   }
}

Output

Let us compile and run the above program, this will produce the following result −

Is SO_OOBINLINE: false
Is SO_OOBINLINE: true

Example 3

The following example shows the usage of Java Socket setOOBInline() method to set the status of SO_OOBINLINE flag of socket instance, if socket is already closed. As first step, we've created a Socket instance using no argument constructor. Using socket.close(), we're closing the socket. Now, we're printing the SO_OOBINLINE flag using getOOBInline() method. Then we're setting the SO_OOBINLINE flag as true using setOOBInline() method and print the same. In the end, we closed the socket using close() method. As socket is already closed, getOOBInline() method call throws an exception as shown below −

package com.tutorialspoint;

import java.io.IOException;
import java.net.Socket;

public class SocketDemo {
   public static void main(String[] args) throws IOException {
      Socket socket = new Socket();  
      socket.close();	  

      // System.out.println("Is SO_OOBINLINE: "+socket.getOOBInline());
      socket.setOOBInline(true);  
      System.out.println("Is SO_OOBINLINE: "+socket.getOOBInline());
      socket.close();
   }
}

Output

Let us compile and run the above program, this will produce the following result −

Exception in thread "main" java.net.SocketException: Socket is closed
	at java.base/java.net.Socket.setOOBInline(Socket.java:1114)
	at com.tutorialspoint.SocketDemo.main(SocketDemo.java:12)

java-socket.htm