HTTPSecureSocket

From Xojo Documentation
Jump to: navigation, search

Class (inherits from SSLSocket)

Used to do secure transmissions via the HTTP 1.0 protocol using the SSL or TLS protocols.

Events
AuthenticationRequired Error ProxyAuthenticationRequired
Connected HeadersReceived ReceiveProgress
DownloadComplete PageReceived SendProgress


Properties
Address ErrorCode NetworkInterface
BytesAvailable ReadOnlyProperty.png HTTPProxyAddress Port
BytesLeftToSend ReadOnlyProperty.png HTTPProxyPort RemoteAddress ReadOnlyProperty.png
CertificateFile HTTPStatusCode RequestHeaders
CertificatePassword Handle ReadOnlyProperty.png SSLConnected ReadOnlyProperty.png
CertificateRejectionFile IsConnected ReadOnlyProperty.png SSLConnecting ReadOnlyProperty.png
ConnectionType LastErrorCode ReadOnlyProperty.png Secure
DefaultPort LocalAddress ReadOnlyProperty.png Yield


Methods
ClearRequestHeaders Listen SendRequest
Close Lookahead SetFormData
Connect PageHeaders SetPostContent
Disconnect Poll SetRequestContent
EncodeFormData Post SetRequestHeader
Get Purge
GetHeaders ReadAll

Notes

NOTE: If you need HTTP 1.1 support, use Xojo.Net.HTTPSocket instead.


Use the HTTPSecureSocket class to perform secure communications via the HTTP protocol. It is identical to the HTTPSocket class except that it is derived from the SSLSocket class instead of the TCPSocket class. This means that you can use the Secure property of SSLSocket to switch to HTTPS. When you set Secure to True, the default port changes from 80 to 443. It supports HTTP proxies while in secure mode.

If you use a constructor in a subclass of HTTPSecureSocket, you must call the Super class's constructor in your subclass's constructor. The subclass will not work unless this is done. You can use the Super keyword for this purpose.

Xojo Cloud

Web apps running on Xojo Cloud first have to use the FirewallPort class to open the port used to connect to an outside web server.

Examples

A simple, secure connection:

Dim secureSite As New HTTPSecureSocket
secureSite.Secure = True
secureSite.ConnectionType = SSLSocket.TLSv12
Dim data As String
data = secureSite.Get("https://www.example.com", 30)

The following example posts a simple form:

Dim form As Dictionary
Dim socket1 As HTTPSecureSocket
socket1 = New HTTPSecureSocket
socket1.Secure = True

// create and populate the form object
form = New Dictionary
form.Value("firstname") = "Bob"
form.Value("lastname") = "Brown"

// setup the socket to POST the form
socket1.SetFormData(form)
socket1.Post("https://www.myformlocation.com/form.php")

See Also

HTTPSocket, SSLSocket, SocketCore, TCPSocket classes.

Xojo.Net.HTTPSocket

Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About