Studio:Transport Server Component: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
| bgcolor="#66ff99" | '''Description'''<br>
| bgcolor="#66ff99" | '''Description'''<br>
|-
|-
| '''OnConnect()'''  
|  
| Method/Event
HRESULT'''OnConnect ('''void''')'''
| Fired when the transport connection state changes from disconnected to connected.
 
| Method
| Event method fired when the transport connection state changes from disconnected to connected.
|-
|-
| '''OnDisconnect ()'''  
|  
| Method/Event
HRESULT'''OnDisconnect ('''void''')'''
| Fired when the transport connection state changes from connected to disconnected.
 
| Method  
| Event method fired when the transport connection state changes from connected to disconnected.
|-
|-
| '''OnEvent('''String message ''')'''  
|  
| Method/Event
HRESULT'''OnEvent('''
| Fired when there is a reportable event in the transport communication.
 
&nbsp;&nbsp; TSEventType type,
 
&nbsp;&nbsp; TSEventLevel level,
 
&nbsp;&nbsp; String message  
 
''')'''
 
| Method
| Event method fired when there is a reportable event in the transport communication.
|}
|}


Line 46: Line 60:
| Returns the current active transport object or null if none is active.
| Returns the current active transport object or null if none is active.
|-
|-
|  
| bool Connect (
{| class="FCK__ShowTableBorders" border="0"
int timeout [optional],  
|-
 
| '''bool Connect('''
bool* stat ) <br>Method
|-
| &nbsp;&nbsp;&nbsp;int timeout[optional],
|-
| &nbsp;&nbsp;&nbsp;bool* stat''')'''
|}


| Method
| Attempts to create a runtime connection to a target using the active transport. The timeout value (in milliseconds) is passed to the runtime connection request and it fails if timeout is exceeded. Default timeout is 5 seconds (5000). Returns true if connection succeeded, false if either the transport or runtime connection failed.
| Attempts to create a runtime connection to a target using the active transport. The timeout value (in milliseconds) is passed to the runtime connection request and it fails if timeout is exceeded. Default timeout is 5 seconds (5000). Returns true if connection succeeded, false if either the transport or runtime connection failed.
|-
|-
Line 80: Line 88:
| Database settings.
| Database settings.
|-
|-
| '''bool Disconnect('''<br>&nbsp;&nbsp;&nbsp;bool* stat''')'''
| bool'''Disconnect('''<br>&nbsp;&nbsp;&nbsp;bool* stat''')'''  
| Method  
| Method  
| Attempts to disconnect the runtime and the transport from the target. Returns true if successfully disconnected.
| Attempts to disconnect the runtime and the transport from the target. Returns true if successfully disconnected.
|-
|-
| '''bool DisconnectAsync('''<br>&nbsp;&nbsp;&nbsp;bool* stat''')'''
| bool'''DisconnectAsync('''<br>&nbsp;&nbsp;&nbsp;bool* stat''')'''  
| Method  
| Method  
| Initiates the request to disconnect from the target, but does not wait fo an acknowledgement of the disconnect request from runtime. Returns true if disconnect request initiated.
| Initiates the request to disconnect from the target, but does not wait fo an acknowledgement of the disconnect request from runtime. Returns true if disconnect request initiated.
|-
|-
| IBlockDataDump  
| IBlockDataDump  
| Property,<br>bool
| Property,<br>bool  
| Turns IBlock dumps on or off. Default is off. If enabled, all IBlocks that are sent and received will be dumped to the STRIDE application log and to a predefined tracepoint.
| Turns IBlock dumps on or off. Default is off. If enabled, all IBlocks that are sent and received will be dumped to the STRIDE application log and to a predefined tracepoint.
|-
|-
| IsConnected  
| IsConnected  
| Property,<br>'''Read-only''',<br>bool
| Property,<br>'''Read-only''',<br>bool  
| Returns the current connection state.
| Returns the current connection state.
|-
|-
Line 105: Line 113:
|-
|-
| TargetRuntimeVersion  
| TargetRuntimeVersion  
| Property,<br>string
| Property,<br>string  
| Returns the runtime version string.
| Returns the runtime version string.
|-
|-
Line 117: Line 125:
|-
|-
| TransportsLocation  
| TransportsLocation  
| Property,<br>string
| Property,<br>string  
| Sets/gets the current directory for transport DLLs. Changing this value will immediately change the values in the Transports collection and will cause the current connection (if any) to be closed.
| Sets/gets the current directory for transport DLLs. Changing this value will immediately change the values in the Transports collection and will cause the current connection (if any) to be closed.
|-
|-
| TransportDataDump  
| TransportDataDump  
| Property,<br>bool
| Property,<br>bool  
| Turns raw data dumps on or off. Default is off. If enabled, all SLAP messages that are sent and received by the transport will be dumped to the STRIDE application log and to a predefined tracepoint.
| Turns raw data dumps on or off. Default is off. If enabled, all SLAP messages that are sent and received by the transport will be dumped to the STRIDE application log and to a predefined tracepoint.
|}
|}
Line 135: Line 143:
| bgcolor="#66ff99" | '''Description'''<br>
| bgcolor="#66ff99" | '''Description'''<br>
|-
|-
| IsLoaded
| IsLoaded  
| Property,<br>'''Read-only''',<br>bool
| Property,<br>'''Read-only''',<br>bool  
| Returns true if the database is loaded.
| Returns true if the database is loaded.
|-
|-
| '''HRESULT Lload('''<br>&nbsp;&nbsp;&nbsp;String FullPath,<br>&nbsp;&nbsp;&nbsp;bool stat<br>''')'''
| HRESULT'''Load('''<br>&nbsp;&nbsp;&nbsp;String FullPath,<br>&nbsp;&nbsp;&nbsp;bool stat<br>''')'''  
| Method  
| Method  
| Loads the database.
| Loads the database.
|-
|-
| Path&nbsp;  
| Path&nbsp;  
| Property,<br>'''Read-only''',<br>String
| Property,<br>'''Read-only''',<br>String  
| Returns the path to the database.
| Returns the path to the database.
|-
|-
| '''HRESULT Unload('''<br>&nbsp;&nbsp;&nbsp;bool stat<br>''')'''
| HRESULT'''Unload('''<br>&nbsp;&nbsp;&nbsp;bool stat<br>''')'''  
| Method  
| Method  
| Unloads the database.
| Unloads the database.
Line 182: Line 190:
| The timeout value in milliseconds.
| The timeout value in milliseconds.
|-
|-
| '''HResult Start('''<br>bool* pVal''')'''  
|  
HRESULT'''Start('''<br>&nbsp;&nbsp; bool* pVal
 
''')'''
 
| Method  
| Method  
| Start the loopback processing.
| Start the loopback processing.
|-
|-
| '''HResult Stop('''<br>bool* pVal''')'''  
|  
HRESULT'''Stop('''<br>&nbsp;&nbsp; bool* pVal
 
''')'''
 
| Method  
| Method  
| Stops&nbsp;the loopback processing.
| Stops&nbsp;the loopback processing.
Line 259: Line 275:
| The number of IBlocks received.
| The number of IBlocks received.
|-
|-
| '''HResult Reset(void)'''  
| HResult '''Reset ('''void''')'''  
| Method  
| Method  
| Resets the counts to zero.
| Resets the counts to zero.
Line 282: Line 298:
| Number of Target errors.
| Number of Target errors.
|-
|-
| '''HResult Reset (void)'''  
| HRESULT'''Reset ('''void''')'''  
| Method  
| Method  
| Resets the host/target sequence error counts.
| Resets the host/target sequence error counts.
|-
|-
| '''HResult Update (void)'''  
| HRESULT'''Update ('''void''')'''  
| Method  
| Method  
| Updates the host/target error counts.
| Updates the host/target error counts.
Line 329: Line 345:
| Contains the number of SUID filters.
| Contains the number of SUID filters.
|-
|-
| '''HResult Reset (void)'''  
| HRESULT'''Reset ('''void''')'''  
| Method  
| Method  
| Resets the counts.
| Resets the counts.
|-
|-
| '''HResult Update (void)'''  
| HRESULT'''Update ('''void''')'''  
| Method  
| Method  
| Updates the counts to their current value.
| Updates the counts to their current value.
Line 348: Line 364:
| bgcolor="#66ff99" | '''Description'''<br>
| bgcolor="#66ff99" | '''Description'''<br>
|-
|-
| Count  
| long'''Count ('''void''')'''&nbsp;
| Property,<br>'''Read-only''',<br>integer  
| Property,<br>'''Read-only''',<br>integer  
| Gives the number of transport items in the collection.
| Gives the number of transport items in the collection.
|-
|-
| [[Transport Server Component#transport.Connection.Transports.Item|Item(variant index)]]
|  
[[Transport Server Component#transport.Connection.Transports.Item|Object]]&nbsp;'''Item ('''
 
&nbsp;&nbsp; variant index  
 
''')'''
 
| Method  
| Method  
| Returns the specified transport item. Index can be a zero-based integer value or a string representing the name of the transport. Each transport advertises a unique name via its API and that’s what we use as the string keys. As per our usual policy, out-of-range integer indices will generate exceptions and out-of-range string indices will return null.
| Returns the specified transport item. Index can be a zero-based integer value or a string representing the name of the transport. Each transport advertises a unique name via its API and that’s what we use as the string keys. As per our usual policy, out-of-range integer indices will generate exceptions and out-of-range string indices will return null.
Line 394: Line 416:
| bgcolor="#66ff99" | '''Description'''<br>
| bgcolor="#66ff99" | '''Description'''<br>
|-
|-
| Count  
| long'''Count ('''void''')'''
| Property,<br>'''Read-only''',<br>integer  
| Property,<br>'''Read-only''',<br>integer  
| Gives the number of properties in the collection.
| Gives the number of properties in the collection.
|-
|-
| [[Transport Server Component#transport.Connection.Transports.Properties.Item|Item(variant index)]]
|  
[[Transport Server Component#transport.Connection.Transports.Properties.Item|Object]] '''Item ('''
 
&nbsp;&nbsp; variant index
 
''')'''
 
| Method  
| Method  
| Returns the specified property item. Index can be a zero-based integer value or a string representing the name of the property. As per our usual policy, out-of-range integer indices will generate exceptions and out-of-range string indices will return null.
| Returns the specified property item. Index can be a zero-based integer value or a string representing the name of the property. As per our usual policy, out-of-range integer indices will generate exceptions and out-of-range string indices will return null.

Revision as of 22:11, 3 July 2008


The Transport Server

The Transport Server fields client requests to a target. The client communicates to the Transport Server. The Transport Server communicates to the target runtime of a target.

To access the transport server, a client first registers with to it using a process id (PID). This is done transparently for script clients using the script wrapper named STRIDE.transport.

Automation API

transport._TSEvents

This is an outgoing connection point interface that is optionally implemented by clients that wish to be notified of connection related events.

Member
 Type
 Description

HRESULTOnConnect (void)

Method Event method fired when the transport connection state changes from disconnected to connected.

HRESULTOnDisconnect (void)

Method Event method fired when the transport connection state changes from connected to disconnected.

HRESULTOnEvent(

   TSEventType type,

   TSEventLevel level,

   String message

)

Method Event method fired when there is a reportable event in the transport communication.

transport.Connection

This is the root object for all connection-related functionality.

Member
 Type
 Description
ActiveTransport Property,
Read-Only,
Object 		Returns the current active transport object or null if none is active.
bool Connect (

int timeout [optional],

bool* stat )
Method

Attempts to create a runtime connection to a target using the active transport. The timeout value (in milliseconds) is passed to the runtime connection request and it fails if timeout is exceeded. Default timeout is 5 seconds (5000). Returns true if connection succeeded, false if either the transport or runtime connection failed.
bool ConnectAsync(
   bool monitor[optional],
   int transportTimeout[optional],
   int runtimeTimeout,
   bool* stat)
Method Makes an asynchronous connection request. A background thread is started to attempt to establish the connection. If monitor is true, the thread will run continuously and attempt to reconnect whenever the connection is lost. If monitor is false (the default) the background thread will exit once a connection is initially established.
Database Object Database settings.
boolDisconnect(
   bool* stat) 		Method Attempts to disconnect the runtime and the transport from the target. Returns true if successfully disconnected.
boolDisconnectAsync(
   bool* stat) 		Method Initiates the request to disconnect from the target, but does not wait fo an acknowledgement of the disconnect request from runtime. Returns true if disconnect request initiated.
IBlockDataDump Property,
bool 		Turns IBlock dumps on or off. Default is off. If enabled, all IBlocks that are sent and received will be dumped to the STRIDE application log and to a predefined tracepoint.
IsConnected Property,
Read-only,
bool 		Returns the current connection state.
Loopback Object  Loopback settings.
Statistics Object Statistics settings.
TargetRuntimeVersion Property,
string 		Returns the runtime version string.
Ping Object Ping settings.
Transports Collection Collection of transports.
TransportsLocation Property,
string 		Sets/gets the current directory for transport DLLs. Changing this value will immediately change the values in the Transports collection and will cause the current connection (if any) to be closed.
TransportDataDump Property,
bool 		Turns raw data dumps on or off. Default is off. If enabled, all SLAP messages that are sent and received by the transport will be dumped to the STRIDE application log and to a predefined tracepoint.

transport.Connection.Database

This is the interface for database settings.

Member
 Type
 Description
IsLoaded Property,
Read-only,
bool 		Returns true if the database is loaded.
HRESULTLoad(
   String FullPath,
   bool stat
) 		Method Loads the database.
Path  Property,
Read-only,
String 		Returns the path to the database.
HRESULTUnload(
   bool stat
) 		Method Unloads the database.

transport.Connection.Loopback

This is the interface for loopback settings.

Member
 Type
 Description
Sent Property,
Read-only,
unsigned long 		Contains the number of loopbacks attempted.
DataErrors Property,
Read-only,
unsigned long 		Contains the number of data errors.
TimeoutErrors Property,
Read-only,
unsigned long 		Contains the number of timeout errors.
Interval Property,
unsigned long 		The interval value in milliseconds.
Timeout Property,
unsigned long 		The timeout value in milliseconds.

HRESULTStart(
   bool* pVal

)

Method Start the loopback processing.

HRESULTStop(
   bool* pVal

)

Method Stops the loopback processing.

transport.Connection.Ping

This is the interface for ping settings. All ping settings are automatically persisted in the registry and restored when the transport server is instantiated.

Member
 Type
 Description
Enabled Property,
bool 		Turns the runtime ping messages on or off. This setting is persisted and restored automatically.
Interval Property,
integer 		Sets/gets the time interval between ping messages, in milliseconds.
RetryCount Property,
integer 		Sets/gets the number of allowable ping failures. Once this number if exceeded, the connection will be closed automatically.
Timeout Property,
integer 		Sets/gets the timeout value for the ping message in milliseconds. If a response is not received within this time, the ping fails.

transport.Connection.Statistics

This is the interface for statistic settings.

Member
 Type
 Description
IBlocks Collection Collection of IBlock statistics.
SequenceErrors Collection Collection of Sequence Errors statistics.
TargetResources Collection Collection of Target Resource statistics.

transport.Connection.Statistics.IBlocks

This is the interface for IBlock settings.

Member
 Type
 Description
Sent Property,
Read-only,
unsigned long 		The number of IBlocks sent.
Received Property,
Read-only,
unsigned long 		The number of IBlocks received.
HResult Reset (void) Method Resets the counts to zero.

transport.Connection.Statistics.SequenceErrors

This is the interface for sequence error settings.

Member
 Type
 Description
Host Property,
Read-only,
unsigned long 		Number of Host errors.
Target Property,
Read-only,
unsigned long 		Number of Target errors.
HRESULTReset (void) Method Resets the host/target sequence error counts.
HRESULTUpdate (void) Method Updates the host/target error counts.

transport.Connection.Statistics.TargetResources

This is the interface for the target resource settings

Member
 Type
 Description
MessageQueue Property,
Read-only,
unsigned long 		Contains the number of message queues.
Subscribers Property,
Read-only,
unsigned long 		Contains the number of subscribers.
EmbeddedPointers Property,
Read-only,
unsigned long 		Contains the number of embedded pointers.
STIDs Property,
Read-only,
unsigned long 		Contains the number of STIDs.
SUIDs Property,
Read-only,
unsigned long 		Contains the number of SUIDs.
SUIDOverrides Property,
Read-only,
unsigned long 		Contains the number of SUID overrides.
SUIDFilters Property,
Read-only,
unsigned long 		Contains the number of SUID filters.
HRESULTReset (void) Method Resets the counts.
HRESULTUpdate (void) Method Updates the counts to their current value.

transport.Connection.Transports

This is the collection of currently available transports.

Member
 Type
 Description
longCount (void)  Property,
Read-only,
integer 		Gives the number of transport items in the collection.

Object Item (

   variant index

)

Method Returns the specified transport item. Index can be a zero-based integer value or a string representing the name of the transport. Each transport advertises a unique name via its API and that’s what we use as the string keys. As per our usual policy, out-of-range integer indices will generate exceptions and out-of-range string indices will return null.

transport.Connection.Transports.Item

This is the interface associated with each transport object.

Member
 Type
 Description
Active Property,
bool 		Sets/gets the active status of the transport. Only one transport can be active at any given time, so setting this to true for a transport that is not already active will cause the current active transport to be disconnected. Setting this property to true when the item is already active is a no-op.
File Property,,
Read-only,
String 		Gets the full file path and name for the corresponding transport DLL.
Name Property,
Read-only,
String 		Gets the name of the transport item.
Properties Collection Collection of properties.

transport.Connection.Transports.Properties

This is the collection of properties for a given transport.

Member
 Type
 Description
longCount (void) Property,
Read-only,
integer 		Gives the number of properties in the collection.

Object Item (

   variant index

)

Method Returns the specified property item. Index can be a zero-based integer value or a string representing the name of the property. As per our usual policy, out-of-range integer indices will generate exceptions and out-of-range string indices will return null.

transport.Connection.Transports.Properties.Item

This is the interface for a specific transport property.

Member
 Type
 Description
AllowableValues Property,
Read-only,
String 		Gets a pipe-delimited string where each delimited value represents an allowable value for the property. Clients might use this to restrict or validate input.
Name Property,
Read-only,
String 		The name of the property item.
Value Property,
String 		The value of the property. When set, the validation method of the transport will be called. Any failures in validation will be returned as exceptions here.
Retrieved from "https://www.stridewiki.com/index.php?title=Studio:Transport_Server_Component&oldid=5755"