IP*Works! SSL rsss Component : rsss OCX, rsss .NET Component, rsss Class, rsss Bean, rsss Object

Available in: SSH | SSL

RSSS Component [IP*Works! SSL V8]

Properties Methods Events Configuration Settings

The RSSS component is used to retrieve, parse, and write RSS syndicated content.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The RSSS component is the SSL-enabled equivalent of the IP*Works! RSS component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the event allow you to check the server identity and other security attributes. Finally, the event provides information about the SSL handshake.

The RSSS component implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The component contains a number of properties that map directly to RSS fields. To receive a feed call the method with the URL or file to retrieve specified in the URL parameter. The RSS component can also generate RSS feeds, which can be retrieved through the property or written through the method.

The RSSS component supports all RSS feed properties that are standard in versions 0.91, 0.92 and 2.0 of the RSS protocol through a number of component properties. It also supports non-standard properties as specified in the RSS protocol through the properties and the and methods.

Optionally, the component can use the Microsoft WinInet library to implement the HTTP functionality. This is triggered by the UseWinInet configuration setting. Although some of the functionality of the component (such as, for example, fine grained control over SSL server authentication) is not available through the WinInet compatibility layer, this option provides access to the Microsoft Internet Explorer settings on the system (such as default proxy settings, etc..) and more compatibility with Internet Explorer in general. This option is only available for Windows platforms.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


Accept	A list of acceptable MIME types for the request.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Channel	The channel of an rss feed.
Connected	Shows whether the component is connected.
Cookies	Collection of cookies.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
IfModifiedSince	A date determining the maximum age of the desired document.
Items	A collection of items in the current RSS feed.
LocalFile	The path to a local file for downloading. If the file exists, it is overwritten.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Namespaces	A collection of namespaces in the current namespace stack.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last request.
Password	A password if authentication is to be used.
Proxy	A set of properties related to proxy access.
Referer	Referer URL/document (optional).
RSSData	The complete text of the RSS XML file.
RSSVersion	The RSS protocol version of the current RSS feed.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during ssl negotiation.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the component.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum of data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
User	A user name if authentication is to be used.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


AddCookie	Adds a cookie and the corresponding value to the outgoing request headers.
AddItem	Insert a new item into the beginning of an RSS feed.
AddNamespace	Adds a namespace to the Namespaces properties .
Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
GetFeed	Fetch an RSS feed.
GetProperty	Get the value of a specific RSS feed item element or attribute.
GetURL	Fetch an RSS feed.
Interrupt	Interrupt the current method.
OPMLAttr	Returns the value of the attribute specified in the parameter.
Put	Sends data to the HTTP server using the HTTP PUT method.
ReadFile	Load an RSS file into the component.
ReadOPML	Read and parse an OPML file.
Reset	Reset all properties of the component.
SetProperty	Set the value of a specific RSS feed property.
WriteFile	Write an RSS feed from the component.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
OPMLHeader	Fired for each value in the Header section of the current OPML document.
OPMLOutline	Fired for each outline in the current OPML document.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


MaxItems	Instructs component to save the amount of specified that are parsed from the rss feed.
ValueFormat	Format of data returned or set
HTTPVersion	The version of HTTP used by the component
UserAgent	Information about the user agent (browser).
Authorization	The Authorization string to be sent to the server.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
ProxyServer	Name or IP address of a proxy server (optional).
ProxyPort	Port for the proxy server (default 80).
ProxyUser	A user name if authentication is to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
IfModifiedSince	A date determining the maximum age of the desired document.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
SSLProvider	The name of the security provider to use.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLSecurityFlags	Flags that control certificate verification
ReuseSSLSession	Determines if the SSL session is reused.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCADir	The path to a directory containing CA certificates.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).