# SocketHandler Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # SocketHandler ``` open class SocketHandler : StreamHandler ``` |---|---|---|--------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||| | ↳ | [java.util.logging.Handler](https://developer.android.com/reference/kotlin/java/util/logging/Handler) ||| | | ↳ | [java.util.logging.StreamHandler](https://developer.android.com/reference/kotlin/java/util/logging/StreamHandler) || | | | ↳ | [java.util.logging.SocketHandler](https://developer.android.com/reference/kotlin/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 \ 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. - \.level specifies the default level for the Handler (defaults to Level.ALL). - \.filter specifies the name of a Filter class to use (defaults to no Filter). - \.formatter specifies the name of a Formatter class to use (defaults to java.util.logging.XMLFormatter). - \.encoding the name of the character set encoding to use (defaults to the default platform encoding). - \.host specifies the target host name to connect to (no default). - \.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](https://developer.android.com/reference/kotlin/java/util/logging/SocketHandler#SocketHandler())`()` Create a SocketHandler, using only LogManager properties (or their defaults). | | [SocketHandler](https://developer.android.com/reference/kotlin/java/util/logging/SocketHandler#SocketHandler(kotlin.String,%20kotlin.Int))`(`host:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `port:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Construct a SocketHandler using a specified host and port. | | Public methods || |----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [close](https://developer.android.com/reference/kotlin/java/util/logging/SocketHandler#close())`()` Close this output stream. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [publish](https://developer.android.com/reference/kotlin/java/util/logging/SocketHandler#publish(java.util.logging.LogRecord))`(`record:` `[LogRecord](https://developer.android.com/reference/kotlin/java/util/logging/LogRecord)!`)` Format and publish a LogRecord. | | Inherited functions || |---|---| | From class[StreamHandler](https://developer.android.com/reference/kotlin/java/util/logging/StreamHandler) |------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [flush](https://developer.android.com/reference/kotlin/java/util/logging/StreamHandler#flush())`()`
Flush any buffered messages.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isLoggable](https://developer.android.com/reference/kotlin/java/util/logging/StreamHandler#isLoggable(java.util.logging.LogRecord))`(`record:` `[LogRecord](https://developer.android.com/reference/kotlin/java/util/logging/LogRecord)!`)`
Check if this Handler would actually log a given LogRecord. This method checks if the LogRecord has an appropriate level and whether it satisfies any Filter. It will also return false if no output stream has been assigned yet or the LogRecord is null.

| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEncoding](https://developer.android.com/reference/kotlin/java/util/logging/StreamHandler#setEncoding(kotlin.String))`(`encoding:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Set (or change) the character encoding used by this Handler. The encoding should be set before any LogRecords are written to the Handler.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setOutputStream](https://developer.android.com/reference/kotlin/java/util/logging/StreamHandler#setOutputStream(java.io.OutputStream))`(`out:` `[OutputStream](https://developer.android.com/reference/kotlin/java/io/OutputStream.html#)!`)`
Change the output stream. If there is a current output stream then the Formatter's tail string is written and the stream is flushed and closed. Then the output stream is replaced with the new output stream.
| || | From class[Handler](https://developer.android.com/reference/kotlin/java/util/logging/Handler) |------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getEncoding](https://developer.android.com/reference/kotlin/java/util/logging/Handler#getEncoding())`()`
Return the character encoding for this Handler.
| | [ErrorManager](https://developer.android.com/reference/kotlin/java/util/logging/ErrorManager)! | [getErrorManager](https://developer.android.com/reference/kotlin/java/util/logging/Handler#getErrorManager())`()`
Retrieves the ErrorManager for this Handler.
| | [Filter](https://developer.android.com/reference/kotlin/java/util/logging/Filter)! | [getFilter](https://developer.android.com/reference/kotlin/java/util/logging/Handler#getFilter())`()`
Get the current Filter for this Handler.
| | [Formatter](https://developer.android.com/reference/kotlin/java/util/logging/Formatter)! | [getFormatter](https://developer.android.com/reference/kotlin/java/util/logging/Handler#getFormatter())`()`
Return the Formatter for this Handler.
| | [Level](https://developer.android.com/reference/kotlin/java/util/logging/Level)! | [getLevel](https://developer.android.com/reference/kotlin/java/util/logging/Handler#getLevel())`()`
Get the log level specifying which messages will be logged by this Handler. Message levels lower than this level will be discarded.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [reportError](https://developer.android.com/reference/kotlin/java/util/logging/Handler#reportError(kotlin.String,%20java.lang.Exception,%20kotlin.Int))`(`msg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `ex:` `[Exception](https://developer.android.com/reference/kotlin/java/lang/Exception.html#)!`, `code:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Protected convenience method to report an error to this Handler's ErrorManager. Note that this method retrieves and uses the ErrorManager without doing a security check. It can therefore be used in environments where the caller may be non-privileged.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setErrorManager](https://developer.android.com/reference/kotlin/java/util/logging/Handler#setErrorManager(java.util.logging.ErrorManager))`(`em:` `[ErrorManager](https://developer.android.com/reference/kotlin/java/util/logging/ErrorManager)!`)`
Define an ErrorManager for this Handler. The ErrorManager's "error" method will be invoked if any errors occur while using this Handler.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setFilter](https://developer.android.com/reference/kotlin/java/util/logging/Handler#setFilter(java.util.logging.Filter))`(`newFilter:` `[Filter](https://developer.android.com/reference/kotlin/java/util/logging/Filter)!`)`
Set a Filter to control output on this Handler. For each call of publish the Handler will call this Filter (if it is non-null) to check if the LogRecord should be published or discarded.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setFormatter](https://developer.android.com/reference/kotlin/java/util/logging/Handler#setFormatter(java.util.logging.Formatter))`(`newFormatter:` `[Formatter](https://developer.android.com/reference/kotlin/java/util/logging/Formatter)!`)`
Set a Formatter. This Formatter will be used to format LogRecords for this Handler. Some Handlers may not use Formatters, in which case the Formatter will be remembered, but not used.

| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setLevel](https://developer.android.com/reference/kotlin/java/util/logging/Handler#setLevel(java.util.logging.Level))`(`newLevel:` `[Level](https://developer.android.com/reference/kotlin/java/util/logging/Level)!`)`
Set the log level specifying which message levels will be logged by this Handler. Message levels lower than this value will be discarded. The intention is to allow developers to turn on voluminous logging, but to limit the messages that are sent to certain Handlers.
| || ## Public constructors ### SocketHandler Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` SocketHandler() ``` Create a SocketHandler, using only LogManager properties (or their defaults). | Exceptions || |--------------------------------------|--------------------------------------------------------------------------------| | `java.lang.IllegalArgumentException` | if the host or port are invalid or are not specified as LogManager properties. | | `java.io.IOException` | if we are unable to connect to the target host and port. | ### SocketHandler Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` SocketHandler(     host: String!,     port: Int) ``` 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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:target host. | | `port` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):target port. | | Exceptions || |--------------------------------------|----------------------------------------------------------| | `java.lang.IllegalArgumentException` | if the host or port are invalid. | | `java.io.IOException` | if we are unable to connect to the target host and port. | ## Public methods ### close Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun close(): Unit ``` Close this output stream. | Exceptions || |-------------------------------|--------------------------------------------------------------------------------------------| | `java.lang.SecurityException` | if a security manager exists and if the caller does not have LoggingPermission("control"). | ### publish Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun publish(record: LogRecord!): Unit ``` Format and publish a LogRecord. | Parameters || |----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `record` | [LogRecord](https://developer.android.com/reference/kotlin/java/util/logging/LogRecord)!:description of the log event. A null record is silently ignored and is not published |