Class NamedPipeSocketFactory

java.lang.Object

com.mysql.jdbc.NamedPipeSocketFactory

All Implemented Interfaces:

SocketFactory, SocketMetadata

public class NamedPipeSocketFactory
extends Object
implements SocketFactory, SocketMetadata

A socket factory for named pipes (on Windows)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	NamedPipeSocketFactory.NamedPipeSocket	A socket that encapsulates named pipes on Windows
(package private) class	NamedPipeSocketFactory.RandomAccessFileInputStream	Enables OutputStream-type functionality for a RandomAccessFile
(package private) class	NamedPipeSocketFactory.RandomAccessFileOutputStream	Enables OutputStream-type functionality for a RandomAccessFile

Nested classes/interfaces inherited from interface SocketMetadata

SocketMetadata.Helper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAMED_PIPE_PROP_NAME

Constructor Summary

Constructors

Constructor	Description
NamedPipeSocketFactory()	Constructor for NamedPipeSocketFactory.

Method Summary

Modifier and Type	Method	Description
Socket	afterHandshake()	Called by the driver after issuing the MySQL protocol handshake and reading the results of the handshake.
Socket	beforeHandshake()	Called by the driver before issuing the MySQL protocol handshake.
Socket	connect(String host, int portNumber, Properties props)	Creates a new socket using the given properties.
boolean	isLocallyConnected(ConnectionImpl conn)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAMED_PIPE_PROP_NAME

public static final String NAMED_PIPE_PROP_NAME

See Also:

• Constant Field Values

Constructor Details

NamedPipeSocketFactory

public NamedPipeSocketFactory()

Constructor for NamedPipeSocketFactory.

Method Details

afterHandshake

public Socket afterHandshake()
                      throws SocketException,
IOException

Description copied from interface: SocketFactory

Called by the driver after issuing the MySQL protocol handshake and reading the results of the handshake.

Specified by:

afterHandshake in interface SocketFactory

Returns:

the socket to use after the handshake

Throws:

SocketException - if a socket error occurs

IOException - if an I/O error occurs

See Also:

• SocketFactory.afterHandshake()

beforeHandshake

public Socket beforeHandshake()
                       throws SocketException,
IOException

Description copied from interface: SocketFactory

Called by the driver before issuing the MySQL protocol handshake. Should return the socket instance that should be used during the handshake.

Specified by:

beforeHandshake in interface SocketFactory

Returns:

the socket to use before the handshake

Throws:

SocketException - if a socket error occurs

IOException - if an I/O error occurs

See Also:

• SocketFactory.beforeHandshake()

connect

public Socket connect(String host,
 int portNumber,
 Properties props)
               throws SocketException,
IOException

Description copied from interface: SocketFactory

Creates a new socket using the given properties. Properties are parsed by the driver from the URL. All properties other than sensitive ones (user and password) are passed to this method. The driver will instantiate the socket factory with the class name given in the property "socketFactory", where the standard is com.mysql.jdbc.StandardSocketFactory Implementing classes are responsible for handling synchronization of this method (if needed).

Specified by:

connect in interface SocketFactory

Parameters:

host - the hostname passed in the JDBC URL. It will be a single hostname, as the driver parses multi-hosts (for failover) and calls this method for each host connection attempt.

portNumber - the port number to connect to (if required).

props - properties passed to the driver via the URL and/or properties instance.

Returns:

a socket connected to the given host

Throws:

SocketException - if a socket error occurs

IOException - if an I/O error occurs

See Also:

• invalid reference

  com.mysql.jdbc.SocketFactory#connect(String, Properties)

isLocallyConnected

public boolean isLocallyConnected(ConnectionImpl conn)
                           throws SQLException

Specified by:

isLocallyConnected in interface SocketMetadata

Throws:

SQLException