# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Ctors | Methods | Inherited Methods

# SocketHandler

`public class SocketHandler`
`` `` `extends StreamHandler` ``

java.lang.Object
↳ | java.util.logging.Handler
| ↳ | java.util.logging.StreamHandler
|  | ↳ | java.util.logging.SocketHandler

Simple network logging `Handler`.

`LogRecords` are published to a network stream connection. By default the `XMLFormatter` class is used for formatting.

Configuration: By default each `SocketHandler` is initialized using the following `LogManager` configuration properties where `<handler-name>` refers to the fully-qualified class name of the handler. If properties are not defined (or have invalid values) then the specified default values are used.

- <handler-name>.level specifies the default level for the `Handler` (defaults to `Level.ALL`).
- <handler-name>.filter specifies the name of a `Filter` class to use (defaults to no `Filter`).
- <handler-name>.formatter specifies the name of a `Formatter` class to use (defaults to `java.util.logging.XMLFormatter`).
- <handler-name>.encoding the name of the character set encoding to use (defaults to the default platform encoding).
- <handler-name>.host specifies the target host name to connect to (no default).
- <handler-name>.port specifies the target TCP port to use (no default).

For example, the properties for `SocketHandler` would be:

- java.util.logging.SocketHandler.level=INFO
- java.util.logging.SocketHandler.formatter=java.util.logging.SimpleFormatter

For a custom handler, e.g. com.foo.MyHandler, the properties would be:

- com.foo.MyHandler.level=INFO
- com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter

The output IO stream is buffered, but is flushed after each `LogRecord` is written.

## Summary

### Public constructors
`SocketHandler()` Create a `SocketHandler`, using only `LogManager` properties (or their defaults).
`SocketHandler(String host, int port)` Construct a `SocketHandler` using a specified host and port.

### Public methods
`void` | `close()` Close this output stream.
`void` | `publish(LogRecord record)` Format and publish a `LogRecord`.

### Inherited methods
From class `java.util.logging.StreamHandler`
`void` | `close()` Close the current output stream.
`void` | `flush()` Flush any buffered messages.
`boolean` | `isLoggable(LogRecord record)` Check if this `Handler` would actually log a given `LogRecord`.
`void` | `publish(LogRecord record)` Format and publish a `LogRecord`.
`void` | `setEncoding(String encoding)` Set (or change) the character encoding used by this `Handler`.
`void` | `setOutputStream(OutputStream out)` Change the output stream.
From class `java.util.logging.Handler`
`abstract void` | `close()` Close the `Handler` and free all associated resources.
`abstract void` | `flush()` Flush any buffered output.
`String` | `getEncoding()` Return the character encoding for this `Handler`.
`ErrorManager` | `getErrorManager()` Retrieves the ErrorManager for this Handler.
`Filter` | `getFilter()` Get the current `Filter` for this `Handler`.
`Formatter` | `getFormatter()` Return the `Formatter` for this `Handler`.
`Level` | `getLevel()` Get the log level specifying which messages will be logged by this `Handler`.
`boolean` | `isLoggable(LogRecord record)` Check if this `Handler` would actually log a given `LogRecord`.
`abstract void` | `publish(LogRecord record)` Publish a `LogRecord`.
`void` | `reportError(String msg, Exception ex, int code)` Protected convenience method to report an error to this Handler's ErrorManager.
`void` | `setEncoding(String encoding)` Set the character encoding used by this `Handler`.
`void` | `setErrorManager(ErrorManager em)` Define an ErrorManager for this Handler.
`void` | `setFilter(Filter newFilter)` Set a `Filter` to control output on this `Handler`.
`void` | `setFormatter(Formatter newFormatter)` Set a `Formatter`.
`void` | `setLevel(Level newLevel)` Set the log level specifying which message levels will be logged by this `Handler`.
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

## Public constructors

### SocketHandler

    public SocketHandler ()

Create a `SocketHandler`, using only `LogManager` properties (or their defaults).

Throws
`IllegalArgumentException` | if the host or port are invalid or are not specified as LogManager properties.
`IOException` | if we are unable to connect to the target host and port.

### SocketHandler

    public SocketHandler (String host,
                    int port)

Construct a `SocketHandler` using a specified host and port. The `SocketHandler` is configured based on `LogManager` properties (or their default values) except that the given target host and port arguments are used. If the host argument is empty, but not null String then the localhost is used.

Parameters
`host` | `String`: target host.
`port` | `int`: target port.

Throws
`IllegalArgumentException` | if the host or port are invalid.
`IOException` | if we are unable to connect to the target host and port.

## Public methods

### close

    public void close ()

Close this output stream.

Throws
`SecurityException` | if a security manager exists and if the caller does not have `LoggingPermission("control")`.

### publish

    public void publish (LogRecord record)

Format and publish a `LogRecord`.

Parameters
`record` | `LogRecord`: description of the log event. A null record is silently ignored and is not published

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*