View source

class Socket

package sys.ssl

extends Socket

@:coreApi

Available on neko, cpp, java, lua, hl, php, python, macro

A TLS socket class : allow you to both connect to a given server and exchange messages or start your own server and wait for connections.

Static variables

staticDEFAULT_CA:Null<Certificate>

Available on neko, cpp, java, hl, php, python, macro

@:value(true)staticDEFAULT_VERIFY_CERT:Null<Bool> = true

Available on neko, cpp, java, hl, php, python, macro

Constructor

new()

Variables

verifyCert:Null<Bool>

Available on neko, cpp, java, hl, php, python, macro

Define if peer certificate is verified during SSL handshake.

Methods

addSNICertificate(cbServernameMatch:String ‑> Bool, cert:Certificate, key:Key):Void

Available on neko, cpp, java, hl, php, python, macro

Configure additionals certificates and private keys for Server Name Indication extension. The callback may be called during handshake to determine the certificate to use.

handshake():Void

Perform the SSL handshake.

peerCertificate():Certificate

Available on neko, cpp, java, hl, php, python, macro

Return the certificate received from the other side of a connection.

setCA(cert:Certificate):Void

Available on neko, cpp, java, hl, php, python, macro

Configure the certificate chain for peer certificate verification.

setCertificate(cert:Certificate, key:Key):Void

Available on neko, cpp, java, hl, php, python, macro

Configure own certificate and private key.

setHostname(name:String):Void

Available on neko, cpp, java, hl, php, python, macro

Configure the hostname for Server Name Indication TLS extension.

Inherited Variables

Defined by Socket

custom:Dynamic

Available on neko, cpp, java, cs, hl, php, python, macro

A custom value that can be associated with the socket. Can be used to retrieve your custom infos after a select.

read onlyinput:Input

The stream on which you can read available data. By default the stream is blocking until the requested data is available, use setBlocking(false) or setTimeout to prevent infinite waiting.

read onlyoutput:Output

The stream on which you can send data. Please note that in case the output buffer you will block while writing the data, use setBlocking(false) or setTimeout to prevent that.

Inherited Methods

Defined by Socket

@:has_untypedhost():{port:Int, host:Host}

Return the information about our side of a connected socket.

listen(connections:Int):Void

Allow the socket to listen for incoming questions. The parameter tells how many pending connections we can have until they get refused. Use accept() to accept incoming connections.

@:has_untypedpeer():{port:Int, host:Host}

Return the information about the other side of a connected socket.

setFastSend(b:Bool):Void

Allows the socket to immediately send the data when written to its output : this will cause less ping but might increase the number of packets / data size, especially when doing a lot of small writes.

setTimeout(timeout:Float):Void

Gives a timeout (in seconds) after which blocking socket operations (such as reading and writing) will abort and throw an exception.

shutdown(read:Bool, write:Bool):Void

Shutdown the socket, either for reading or writing.

waitForRead():Void

Block until some data is available for read on the socket.