Module ocs_eap_tls_transport

Description
Data Types
Function Index
Function Details

This callback module provides a gen_tcp compatible transport layer interface to EAP sessions for the ssl application.

Copyright © 2016 - 2026 SigScale Global Inc.

Description

This callback module provides a gen_tcp compatible transport layer interface to EAP sessions for the ssl application.

Use the ssl:transportoption() {cb_info, {ocs_eap_tls_transport, eap_tls, eap_tls_closed, eap_tls_error}} with ssl:listen/2.

Data Types

eap_option()

eap_option() = any()

listen_option()

listen_option() = any()

Function Index

ssl_listen/2	Creates an ssl listen socket.
deliver/3	Deliver received EAP-TLS payload to SSL.
peername/1	Returns the address and port for the other end of a connection.
sockname/1	Returns the local address and port number for an EAP session.
port/1	Returns the local port number for an EAP session.
setopts/2	Sets one or more options for an EAP session.
getopts/2	Gets one or more options for an EAP session.
listen/2	Listen on an EAP session.
accept/2	Accepts an incoming connection request on a listen socket.
shutdown/2	Close an EAP session in one or two directions.
close/1	Close an EAP session.
send/2	Sends a packet on an EAP session.
controlling_process/2	Assigns a new controlling process Pid to EAP session.

Function Details

ssl_listen/2

ssl_listen(TlsFsm, Options) -> {ok, TlsRecordLayerSocket} | {error, Reason}

TlsFsm = pid()
Options = [ssl:ssl_option()]
TlsRecordLayerSocket = ssl:sslsocket()
Reason = term()

Creates an ssl listen socket.

deliver/3

deliver(SslPid, TlsFsm, Data) -> ok

SslPid = pid()
TlsFsm = pid()
Data = iodata()

Deliver received EAP-TLS payload to SSL.

peername/1

peername(TlsFsm) -> {ok, {Address, Port}} | {error, Reason}

TlsFsm = pid()
Address = inet:ip_address()
Port = inet:port_number()
Reason = term()

Returns the address and port for the other end of a connection.

sockname/1

sockname(TlsFsm) -> {ok, {Address, Port}} | {error, Reason}

TlsFsm = pid()
Address = inet:ip_address()
Port = inet:port_number()
Reason = term()

Returns the local address and port number for an EAP session.

port/1

port(TlsFsm) -> {ok, Port} | {error, Reason}

TlsFsm = pid()
Port = inet:port_number()
Reason = term()

Returns the local port number for an EAP session.

setopts/2

setopts(TlsFsm, Options) -> ok | {error, Reason}

TlsFsm = pid()
Options = [eap_option()]
Reason = term()

Sets one or more options for an EAP session.

getopts/2

getopts(TlsFsm, Options) -> {ok, OptionValues} | {error, Reason}

TlsFsm = pid()
Options = [eap_option()]
OptionValues = [eap_option()]
Reason = term()

Gets one or more options for an EAP session.

listen/2

listen(TlsFsm, Options) -> {ok, TlsFsm} | {error, Reason}

TlsFsm = pid()
Options = [listen_option()]
Reason = term()

Listen on an EAP session.

accept/2

accept(TlsFsm, Timeout) -> {ok, TlsFsm} | {error, Reason}

TlsFsm = pid()
Timeout = timeout()
Reason = term()

Accepts an incoming connection request on a listen socket.

shutdown/2

shutdown(TlsFsm, How) -> ok | {error, Reason}

TlsFsm = pid()
How = read | write | read_write
Reason = term()

Close an EAP session in one or two directions.

close/1

close(TlsFsm) -> ok

TlsFsm = pid()

Close an EAP session.

send/2

send(TlsFsm, Data) -> ok | {error, Reason}

TlsFsm = pid()
Data = iodata()
Reason = closed | term()

Sends a packet on an EAP session.

controlling_process/2

controlling_process(TlsFsm, Pid) -> ok | {error, Reason}

TlsFsm = pid()
Pid = pid()
Reason = closed | not_owner | term()

Assigns a new controlling process Pid to EAP session.

Generated by EDoc