Java - Socket setPerformancePreferences() Method

Description

The Java Socket setPerformancePreferences() sets performance preferences for this socket. Sockets use the TCP/IP protocol by default. Some implementations may offer alternative protocols which have different performance characteristics than TCP/IP. This method allows the application to express its own preferences as to how these tradeoffs should be made when the implementation chooses from the available protocols.

Declaration

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

public void setPerformancePreferences(int connectionTime, int latency, int bandwidth)

Parameters

connectionTime − An int expressing the relative importance of a short connection time.

latency − An int expressing the relative importance of low latency.

bandwidth − An int expressing the relative importance of high bandwidth.

Return Value

NA

Exception

NA

Example 1

The following example shows the usage of Java Socket setPerformancePreferences() method to set the performance preferences 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 setPerformancePreferences using setPerformancePreferences() method. Once done, we're printing 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.setPerformancePreferences(100,10,100); 
      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 −

Port number: 6066
Inet Address: null

Example 2

The following example shows the usage of Java Socket setPerformancePreferences() method to set the performance preferences of socket instance. As first step, we've created a Socket instance using no argument constructor. Then we're setting the SO_OOBINLINE flag as true using setPerformancePreferences() method and print the same.Then we're setting the setPerformancePreferences using setPerformancePreferences() method. 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);	  
      socket.setPerformancePreferences(100,10,100);  
      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 setPerformancePreferences() method to set the performance preferences 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 setPerformancePreferences() method and print the same. Then we're setting the setPerformancePreferences using setPerformancePreferences() method. 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);
      socket.setPerformancePreferences(100,10,100); 	  
      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)