OpenSplice Java FACE API  v6.x
OpenSplice Future Airborne Capability Environment (FACE) Java API
org.vortex.FACE.TransportServices Class Reference
Collaboration diagram for org.vortex.FACE.TransportServices:
Collaboration graph

Public Member Functions

void Create_Connection (String connection_name, MESSAGING_PATTERN_TYPE pattern, us.opengroup.FACE.LongHolder connection_id, CONNECTION_DIRECTION_TYPEHolder connection_direction, us.opengroup.FACE.IntHolder max_message_size, long timeout, RETURN_CODE_TYPEHolder return_code)
 
void Destroy_Connection (long connection_id, RETURN_CODE_TYPEHolder return_code)
 For DDS, TS shall keep track of the DomainParticipant and Topic variables for deletion. More...
 
void Get_Connection_Parameters (us.opengroup.FACE.StringHolder connection_name, us.opengroup.FACE.LongHolder connection_id, TRANSPORT_CONNECTION_STATUS_TYPEHolder connection_status, RETURN_CODE_TYPEHolder return_code)
 
void Initialize (String configuration, RETURN_CODE_TYPEHolder return_code)
 

Detailed Description

Definition at line 40 of file TransportServices.java.

Member Function Documentation

◆ Create_Connection()

void org.vortex.FACE.TransportServices.Create_Connection ( String  connection_name,
MESSAGING_PATTERN_TYPE  pattern,
us.opengroup.FACE.LongHolder  connection_id,
CONNECTION_DIRECTION_TYPEHolder  connection_direction,
us.opengroup.FACE.IntHolder  max_message_size,
long  timeout,
RETURN_CODE_TYPEHolder  return_code 
)

Definition at line 88 of file TransportServices.java.

◆ Destroy_Connection()

void org.vortex.FACE.TransportServices.Destroy_Connection ( long  connection_id,
RETURN_CODE_TYPEHolder  return_code 
)

For DDS, TS shall keep track of the DomainParticipant and Topic variables for deletion.

For SOURCE connection_direction, the Publisher and DataWriter shall be kept track of for deletion. For DESTINATION connection_direction, the Subscriber and DataReader shall be kept track of for deletion.

Possible return codes:

  • NO_ERROR - Successful completion.
  • NO_ACTION - Object target of this operation has already been deleted.
  • INVALID_MODE - An operation was invoked on an inappropriate object or at an inappropriate time.
  • INVALID_PARAM - Connection identification (ID) invalid.
  • NOT_AVAILABLE - Unsupported operation.
  • INVALID_CONFIG - Generic, unspecified error.
  • INVALID_MODE - A pre-condition for the operation was not met. Note: In a FACE implementation, this error may imply an implementation problem since the connection is deleted and should clean up all entities/children associated with the connection.
Parameters
connection_idThe connection_id of the connection that needs to be destroyed. This is an input parameter.
return_codeThe return_code This is an output parameter.

Definition at line 189 of file TransportServices.java.

◆ Get_Connection_Parameters()

void org.vortex.FACE.TransportServices.Get_Connection_Parameters ( us.opengroup.FACE.StringHolder  connection_name,
us.opengroup.FACE.LongHolder  connection_id,
TRANSPORT_CONNECTION_STATUS_TYPEHolder  connection_status,
RETURN_CODE_TYPEHolder  return_code 
)
  • NO_ERROR - Successful completion.
  • INVALID_PARAM - Connection ID invalid.
  • NOT_AVAILABLE - Implementation not available.

Definition at line 534 of file TransportServices.java.

◆ Initialize()

void org.vortex.FACE.TransportServices.Initialize ( String  configuration,
RETURN_CODE_TYPEHolder  return_code 
)

Definition at line 48 of file TransportServices.java.


The documentation for this class was generated from the following file: