Complete CDAS R1.8.20 Web Services API

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

spdfhttpproxy__define.pro


This class represent HTTP proxy settings.

Author information

Author

B. Harris

Copyright

Copyright (c) 2021 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

Class description for SpdfHttpProxy

Properties

Properties in SpdfHttpProxy

authentication init
hostname init
password init
port init
username init

Fields

Fields in SpdfHttpProxy

AUTHENTICATION 0L
HOSTNAME ''
PASSWORD ''
PORT ''
USERNAME ''

Routines

Routines from spdfhttpproxy__define.pro

result = SpdfHttpProxy::init( [authentication=int] [, hostname=string] [, port=string] [, username=string] [, password=string])

Creates an SpdfHttpProxy object with values suitable for use with the IDLnetURL object.

SpdfHttpProxy::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfHttpProxy::getAuthentication()

Gets the authentication value.

SpdfHttpProxy::setAuthentication, value

Sets the authentication value.

result = SpdfHttpProxy::getHostname()

Gets the hostname value.

SpdfHttpProxy::setHostname, value

Sets the hostname value.

result = SpdfHttpProxy::getPassword()

Gets the password value.

SpdfHttpProxy::setPassword, value

Sets the password value.

result = SpdfHttpProxy::getPort()

Gets the port value.

SpdfHttpProxy::setPort, value

Sets the port value.

result = SpdfHttpProxy::getUsername()

Gets the username value.

SpdfHttpProxy::setUsername, value

Sets the username value.

SpdfHttpProxy__define

Routine details

top source SpdfHttpProxy::init

result = SpdfHttpProxy::init( [authentication=int] [, hostname=string] [, port=string] [, username=string] [, password=string])

Creates an SpdfHttpProxy object with values suitable for use with the IDLnetURL object. If no parameter values are given, the HTTP_PROXY environment variable is examined. If it has a value, then its value is used to initialize this object. The HTTP_PROXY value should be of the form http://username:password@hostname:port/. If the HTTP_PROXY environment is not set, this object's initial value will indicate to IDLnetURL not to use a proxy. See IDLnetURL documentation for more details about the values.

Keywords

authentication in optional type=int

Type of authentication used when connecting to a proxy server.

hostname in optional type=string

The proxy server name.

port in optional type=string

The proxy's TCP/IP port.

username in optional type=string

Username for authenticating with the proxy server.

password in optional type=string

Password for authenticating with the proxy server.

top source SpdfHttpProxy::cleanup

SpdfHttpProxy::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfHttpProxy::getAuthentication

result = SpdfHttpProxy::getAuthentication()

Gets the authentication value.

Return value

authentication value.

top source SpdfHttpProxy::setAuthentication

SpdfHttpProxy::setAuthentication, value

Sets the authentication value.

Parameters

value in type=int

new value.

top source SpdfHttpProxy::getHostname

result = SpdfHttpProxy::getHostname()

Gets the hostname value.

Return value

hostname value.

top source SpdfHttpProxy::setHostname

SpdfHttpProxy::setHostname, value

Sets the hostname value.

Parameters

value in type=string

new value.

top source SpdfHttpProxy::getPassword

result = SpdfHttpProxy::getPassword()

Gets the password value.

Return value

password value.

top source SpdfHttpProxy::setPassword

SpdfHttpProxy::setPassword, value

Sets the password value.

Parameters

value in type=string

new value.

top source SpdfHttpProxy::getPort

result = SpdfHttpProxy::getPort()

Gets the port value.

Return value

port value.

top source SpdfHttpProxy::setPort

SpdfHttpProxy::setPort, value

Sets the port value.

Parameters

value in type=string

new value.

top source SpdfHttpProxy::getUsername

result = SpdfHttpProxy::getUsername()

Gets the username value.

Return value

username value.

top source SpdfHttpProxy::setUsername

SpdfHttpProxy::setUsername, value

Sets the username value.

Parameters

value in type=string

new value.

top source SpdfHttpProxy__define

SpdfHttpProxy__define

File attributes

Modification date: Tue Sep 28 07:51:33 2021
Lines: 96


CDAS Feedback.