[This is preliminary documentation and is subject to change.]
Properties for the HTTP transport protocol.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class HttpProperties : TransportProperties
<SerializableAttribute> _ Public Class HttpProperties _ Inherits TransportProperties
[SerializableAttribute] public ref class HttpProperties : public TransportProperties
Members| All Members | Constructors | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | HttpPropertiesHttpPropertiesNew()() |
Constructs an empty HttpProperties object
|
| HttpPropertiesHttpPropertiesNew(HttpProperties) | Constructs an HttpProperties object that inherits values from a parent |
 | Host | Gets or sets the local hostname this transport protocol will use when listening
for incoming traffic from the ZIS. Sets the local host name or IP address this transport
protocol will use
when establishing a local socket. By default, localhost is assumed.
This property is useful when more than one network interface is available
on the machine, or when the agent wishes to exercise more control over
the exact hostname or IP address that is registered with the ZIS (e.g.
"localhost" versus "127.0.0.1" versus the IP address or DNS host name of
the local machine.)
|
| KeepAliveOnReceive |
This property determines whether keep-alives are turned on on connections initiated from the
ZIS to the agent ( for "Push" agents ). The default value is TRUE.
|
| KeepAliveOnSend |
This property determines whether keep-alives are turned on on connections initiated from the
agent to the ZIS. The default value is TRUE.
|
| Port | Gets or sets the port that push-mode agents will use when establishing a local socket. Sets the port that push-mode agents will use when establishing a local socket. |
| Protocol | Gets the name of the transport protocol associated with these properties (Overrides TransportProperties.Protocol.) |
| PushHost | Gets or sets the hostname that push-mode agents will use when sending a SIF_Register
message to the zone integration server, if different than the hostname the
agent binds on when establishing the local socket. If set this value
will be used in preparing the SIF_Register/SIF_Protocol/SIF_URL. If not
set, the Adk will use the Host property to prepare this element.
Most agents do not call this method. It is only needed when the network
configuration demands the hostname and port the ZIS uses to contact the
agent is different than the local socket the agent binds on.
|
| PushPort | Gets or Sets the port that push-mode agents will use when sending a SIF_Register
message to the zone integration server, if different than the port the
agent binds on when establishing the local socket. If set this value
will be used in preparing the SIF_Register/SIF_Protocol/SIF_URL. If not
set, the Adk will use the Port property to prepare this element.
|
RemarksTo set default HTTP properties, call the Agent.DefaultHttpProperties method to obtain the agent's default properties for this transport protocol. The defaults are used by all zones that do not explicitly set their own transport properties. Alternatively, you may set the default value of a property by modifying the appropriate setting in the "appSettings" section of the application config file. Property names follow the naming convention adk.transport.http.property (e.g. adk.transport.http.port).
No default HTTP or HTTPS port is assigned to push mode agents by the class framework. It is the developer's responsibility to assign a default port. To do so, use one of the following methods:
- Set the adk.transport.https.port system property prior to creating your agent's Zones and/or Topics. This property can be set programmatically by adding it to the "appSettings" node in the application's configuration file.
- Set the Port property on the default HttpProperties and/or HttpsProperties objects prior to creating and your agent's Zones instances.
- Use an agent configuration file that can be read by the [!:Edustructures.SifWorks.Tool.Cfg.AgentConfig] class
Examples
Set the Port property on the default HttpProperties and/or
HttpsProperties objects prior to creating and your agent's Zones
instances. The following block of code demonstrates:
CopyC#
CopyC#// Set transport properties for HTTP Agent myAgent = ... HttpProperties http = agent.DefaultHttpProperties; http.Port = 7081; // Set transport properties for HTTPS HttpsProperties https = agent.DefaultHttpsProperties; https.setPort( 7082 ); ...
Inheritance Hierarchy| Object | ||||
 | AdkProperties | |||
| TransportProperties | |||
| HttpProperties | |||
| HttpsProperties | |||