async-io-ssl-failure-indicator-from-failure-args Function

Summary

Extract the SSL failure from the failure argument list of an asynchronous I/O callback.

Package

comm

Signature

async-io-ssl-failure-indicator-from-failure-args failure-args => ssl-failure-indicator

Arguments

failure-args⇩

Any Lisp object.

Values

ssl-failure-indicator⇩
	A ssl-condition, :timeout, :closed or nil.

Description

The function async-io-ssl-failure-indicator-from-failure-args is intended to be called with the failure arguments list that callback in create-async-io-state-and-connected-tcp-socket and async-io-state-attach-ssl receives as its second argument when a failure occurs. async-io-ssl-failure-indicator-from-failure-args checks if failure-args was generated as such an argument, and if it was, extracts the error indicator from it. ssl-failure-indicator is :timeout if the handshake timed out, :closed if the socket was closed (with a proper shutdown) during the handshake, or a ssl-condition for other SSL failures. ssl-failure-indicator is nil if some other error occured, for example failure to connect.

Notes

async-io-ssl-failure-indicator-from-failure-args is needed because the argument to callback in create-async-io-state-and-connected-tcp-socket and async-io-state-attach-ssl is a list of arguments for format, which is intended for printing/logging. async-io-ssl-failure-indicator-from-failure-args makes it easier to decide programmatically what the reason for failure is.

See also

25.8.8 Errors in SSL
create-async-io-state-and-connected-tcp-socket
async-io-state-attach-ssl