Index

Package: DDS.Builtin_KeyedOctets_DataWriter

Description

package DDS.Builtin_KeyedOctets_DataWriter is

Summary: <<interface>> Instantiates DataWriter < DDS_KeyedOctets >.


See also: FooDataWriter
See also: DDS.DataWriter

Classes

Ref 

type Ref is new DDS.DataWriter_Impl.Ref with null record;

Ancestors:

Primitive operations:

DDS.DataWriter_Impl.Assert_Liveliness (Inherited)
DDS.DataWriter_Impl.Dispose (Inherited)
DDS.DataWriter_Impl.Dispose_W_Timestamp (Inherited)
DDS.DataWriter_Impl.Flush (Inherited)
DDS.DataWriter_Impl.Get_DataWriter_Cache_Status (Inherited)
DDS.DataWriter_Impl.Get_DataWriter_Protocol_Status (Inherited)
DDS.DataWriter_Impl.Get_Key_Value (Inherited)
DDS.DataWriter_Impl.Get_Listener (Inherited)
DDS.DataWriter_Impl.Get_Liveliness_Lost_Status (Inherited)
DDS.DataWriter_Impl.Get_Matched_Subscription_Data (Inherited)
DDS.DataWriter_Impl.Get_Matched_Subscription_Datawriter_Protocol_Status (Inherited)
DDS.DataWriter_Impl.Get_Matched_Subscription_Datawriter_Protocol_Status_By_Locator (Inherited)
DDS.DataWriter_Impl.Get_Matched_Subscription_Locators (Inherited)
DDS.DataWriter_Impl.Get_Matched_Subscriptions (Inherited)
DDS.DataWriter_Impl.Get_Offered_Deadline_Missed_Status (Inherited)
DDS.DataWriter_Impl.Get_Offered_Incompatible_Qos_Status (Inherited)
DDS.DataWriter_Impl.Get_Publication_Matched_Status (Inherited)
DDS.DataWriter_Impl.Get_Publisher (Inherited)
DDS.DataWriter_Impl.Get_Qos (Inherited)
DDS.DataWriter_Impl.Get_Reliable_Reader_Activity_Changed_Status (Inherited)
DDS.DataWriter_Impl.Get_Reliable_Writer_Cache_Changed_Status (Inherited)
DDS.DataWriter_Impl.Get_Topic (Inherited)
DDS.DataWriter_Impl.Lookup_Instance (Inherited)
DDS.DataWriter_Impl.Register_Instance (Inherited)
DDS.DataWriter_Impl.Register_Instance_W_Timestamp (Inherited)
DDS.DataWriter_Impl.Set_Listener (Inherited)
DDS.DataWriter_Impl.Set_Qos (Inherited)
DDS.DataWriter_Impl.Set_Qos_With_Profile (Inherited)
DDS.DataWriter_Impl.Set_Qos_With_Profile (Inherited)
DDS.DataWriter_Impl.Unregister_Instance (Inherited)
DDS.DataWriter_Impl.Unregister_Instance_W_Timestamp (Inherited)
DDS.DataWriter_Impl.Wait_For_Acknowledgments (Inherited)
DDS.DataWriter_Impl.Wait_For_Asynchronous_Publishing (Inherited)
DDS.DataWriter_Impl.Write (Inherited)
DDS.DataWriter_Impl.Write_W_Timestamp (Inherited)
Dispose_W_Key
Dispose_W_Key_W_Params
Dispose_W_Key_W_Timestamp
Dispose_W_Params
Dispose_W_Timestamp
Get_Key_Value
Get_Key_Value_W_Key
Lookup_Instance
Lookup_Instance_W_Key
Register_Instance
Register_Instance_W_Key
Register_Instance_W_Key_W_Params
Register_Instance_W_Key_W_Timestamp
Register_Instance_W_Params
Register_Instance_W_Timestamp
Unregister_Instance
Unregister_Instance_W_Key
Unregister_Instance_W_Key_W_Params
Unregister_Instance_W_Key_W_Timestamp
Unregister_Instance_W_Params
Unregister_Instance_W_Timestamp
Write_Octet_Seq_W_Key_W_Params
Write_Octets_Seq_W_Key
Write_Octets_Seq_W_Key_W_Timestamp
Write_Octets_W_Key
Write_Octets_W_Key_W_Params
Write_Octets_W_Key_W_Timestamp
Write_W_Params
Write_W_Timestamp

Types

Ref_Access 

type Ref_Access is access all Ref'Class;

Ref_Access_Access 

type Ref_Access_Access is access all Ref_Access;

Subprograms & Entries

Narrow 

function Narrow 
(writer: DDS.DataWriter.Ref_Access) return DDS.Builtin_KeyedOctets_DataWriter.Ref_Access;

Summary: Narrow the given DDS.DataWriter pointer to a DDSKeyedOctetsDataWriter pointer.


See also: FooDataWriter.narrow

As_DataWriter 

function As_DataWriter 
(writer: DDS.Builtin_KeyedOctets_DataWriter.Ref_Access) return DDS.DataWriter.Ref_Access;

Summary: Widen the given DDSKeyedOctetsDataWriter pointer to a DDS.DataWriter pointer.


See also: FooDataWriter.as_datawriter

Register_Instance 

function Register_Instance 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets) return DDS.InstanceHandle_T;

Summary: Informs RTI Connext that the application will be modifying a particular instance.


See also: FooDataWriter.register_instance

Register_Instance_W_Timestamp 

function Register_Instance_W_Timestamp 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Source_Timestamp: access DDS.Time_T) return DDS.InstanceHandle_T;

Summary: Performs the same functions as DDSKeyedOctetsDataWriter.register_instance except that the application provides the value for the source_timestamp.


See also: FooDataWriter.register_instance_w_timestamp

Unregister_Instance 

procedure Unregister_Instance 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Handle: access DDS.InstanceHandle_T);

Summary: Reverses the action of DDSKeyedOctetsDataWriter.register_instance.


See also: FooDataWriter.unregister_instance

Unregister_Instance_W_Timestamp 

procedure Unregister_Instance_W_Timestamp 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Handle: access DDS.InstanceHandle_T;
Source_Timestamp: access DDS.Time_T);

Summary: Performs the same function as DDSKeyedOctetsDataWriter.unregister_instance except that it also provides the value for the source_timestamp.


See also: FooDataWriter.unregister_instance_w_timestamp

Write 

procedure Write 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Handle: access DDS.InstanceHandle_T);

Summary: Modifies the value of a DDS_KeyedOctets data instance.


See also: FooDataWriter.write

Write_W_Timestamp 

procedure Write_W_Timestamp 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Handle: access DDS.InstanceHandle_T;
Source_Timestamp: access DDS.Time_T);

Summary: Performs the same function as DDSKeyedOctetsDataWriter.write except that it also provides the value for the source_timestamp.


See also: FooDataWriter.write_w_timestamp

Dispose 

procedure Dispose 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Instance_Handle: access DDS.InstanceHandle_T);

Summary: Requests the middleware to delete the data.


See also: FooDataWriter.dispose

Dispose_W_Timestamp 

procedure Dispose_W_Timestamp 
(This: not null access Ref;
Instance_Data: access DDS.KeyedOctets;
Instance_Handle: access DDS.InstanceHandle_T;
Source_Timestamp: access DDS.Time_T);

Summary: Performs the same functions as DDSKeyedOctetsDataWriter.dispose except that the application provides the value for the source_timestamp that is made available to DDS.DataReader objects by means of the source_timestamp attribute inside the DDS.SampleInfo.


See also: FooDataWriter.dispose_w_timestamp

Get_Key_Value 

procedure Get_Key_Value 
(This: not null access Ref;
Key_Holder: access DDS.KeyedOctets;
Handle: access DDS.InstanceHandle_T);

Summary: Retrieve the instance key that corresponds to an instance handle.


See also: FooDataWriter.get_key_value

Lookup_Instance 

function Lookup_Instance 
(This: not null access Ref;
Key_Holder: access DDS.KeyedOctets) return DDS.InstanceHandle_T;

Summary: Retrieve the instance handle that corresponds to an instance key_holder.


See also: FooDataWriter.lookup_instance

Lookup_Instance_W_Key 

function Lookup_Instance_W_Key 
(This: not null access Ref;
key: DDS.String) return DDS.InstanceHandle_T;

Summary: <<ext>> Retrieve the instance handle that corresponds to an instance key.


See also: FooDataWriter.lookup_instance

Register_Instance_W_Key 

function Register_Instance_W_Key 
(This: not null access Ref;
key: DDS.String) return DDS.InstanceHandle_T;

Summary: <<ext>> Informs RTI Connext that the application will be modifying a particular instance.


See also: FooDataWriter.register_instance

Register_Instance_W_Params 

function Register_Instance_W_Params 
(This: not null access Ref;
instance_data: access DDS.KeyedOctets;
params: access DDS.WriteParams_T) return DDS.InstanceHandle_T;

Register_Instance_W_Key_W_Timestamp 

function Register_Instance_W_Key_W_Timestamp 
(This: not null access Ref;
key: DDS.String;
source_timestamp: access DDS.Time_T) return DDS.InstanceHandle_T;

Summary: <<ext>> Performs the same functions as DDSKeyedOctetsDataWriter::register_instance except that the application provides the value for the source_timestamp.


See also: FooDataWriter.register_instance_w_timestamp

Register_Instance_W_Key_W_Params 

function Register_Instance_W_Key_W_Params 
(This: not null access Ref;
key: DDS.String;
params: access DDS.WriteParams_T) return DDS.InstanceHandle_T;

Unregister_Instance_W_Key 

procedure Unregister_Instance_W_Key 
(This: not null access Ref;
key: DDS.String;
handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Reverses the action of DDSKeyedOctetsDataWriter::register_instance.


See also: FooDataWriter.unregister_instance

Unregister_Instance_W_Params 

procedure Unregister_Instance_W_Params 
(This: not null access Ref;
instance_data: access DDS.KeyedOctets;
params: access DDS.WriteParams_T);

Unregister_Instance_W_Key_W_Timestamp 

procedure Unregister_Instance_W_Key_W_Timestamp 
(This: not null access Ref;
key: DDS.String;
handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: <<ext>> Performs the same function as DDSKeyedOctetsDataWriter::unregister_instance except that it also provides the value for the source_timestamp.


See also: FooDataWriter.unregister_instance_w_timestamp

Unregister_Instance_W_Key_W_Params 

procedure Unregister_Instance_W_Key_W_Params 
(This: not null access Ref;
key: DDS.String;
params: access DDS.WriteParams_T);

Write_Octets_W_Key 

procedure Write_Octets_W_Key 
(This: not null access Ref;
key: DDS.String;
octets: access DDS.Octet_Array;
length: Integer;
handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Modifies the value of a DDS_KeyedOctets data instance.

self: <<in>> Cannot be NULL

key: <<in>> Instance key.

octets: <<in>> Array of octets to be published.

offset: <<in>> Offset from which to start publishing.

length: <<in>> Number of octets to be published.

handle: <<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter.register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter.write.
See also: FooDataWriter.write

Write_Octets_Seq_W_Key 

procedure Write_Octets_Seq_W_Key 
(This: not null access Ref;
key: DDS.String;
octets: access DDS.Octet_Seq.Sequence;
handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Modifies the value of a DDS_KeyedOctets data instance.

self: <<in>> Cannot be NULL

key: <<in>> Instance key.

octets: <<in>> Sequence of octets to be published.

handle: <<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter.register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter.write.
See also: FooDataWriter.write

Write_Octets_W_Key_W_Timestamp 

procedure Write_Octets_W_Key_W_Timestamp 
(This: not null access Ref;
key: DDS.String;
octets: access DDS.Octet_Array;
length: Integer;
handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.

self: <<in>> Cannot be NULL

key: <<in>> Instance key.

octets: <<in>> Array of octets to be published.

offset: <<in>> Offset from which to start publishing.

length: <<in>> Number of octets to be published.

handle: <<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter.register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter.write.

source_timestamp: <<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See FooDataWriter.write_w_timestamp. Cannot be NULL.


See also: FooDataWriter.write

Write_Octets_Seq_W_Key_W_Timestamp 

procedure Write_Octets_Seq_W_Key_W_Timestamp 
(This: not null access Ref;
key: DDS.String;
octets: access DDS.Octet_Seq.Sequence;
handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.

self: <<in>> Cannot be NULL

key: <<in>> Instance key.

octets: <<in>> Sequence of octets to be published.

handle: <<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter.register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter.write.

source_timestamp: <<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See FooDataWriter.write_w_timestamp. Cannot be NULL.


See also: FooDataWriter.write

Write_W_Params 

procedure Write_W_Params 
(This: not null access Ref;
instance_data: access DDS.KeyedOctets;
params: access DDS.WriteParams_T);

Write_Octets_W_Key_W_Params 

procedure Write_Octets_W_Key_W_Params 
(This: not null access Ref;
key: DDS.String;
octets: access DDS.Octet_Array;
length: Integer;
params: access DDS.WriteParams_T);

Write_Octet_Seq_W_Key_W_Params 

procedure Write_Octet_Seq_W_Key_W_Params 
(This: not null access Ref;
key: DDS.String;
octets: access DDS.Octet_Seq.Sequence;
params: access DDS.WriteParams_T);

Dispose_W_Key 

procedure Dispose_W_Key 
(This: not null access Ref;
key: DDS.String;
instance_handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Requests the middleware to delete the data.


See also: FooDataWriter.dispose

Dispose_W_Params 

procedure Dispose_W_Params 
(This: not null access Ref;
instance_data: access DDS.KeyedOctets;
source_timestamp: access DDS.WriteParams_T);

Dispose_W_Key_W_Timestamp 

procedure Dispose_W_Key_W_Timestamp 
(This: not null access Ref;
key: DDS.String;
instance_handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: <<ext>> Performs the same functions as DDSKeyedOctetsDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDS.DataReader objects by means of the source_timestamp attribute inside the DDS.SampleInfo.


See also: FooDataWriter.dispose_w_timestamp

Dispose_W_Key_W_Params 

procedure Dispose_W_Key_W_Params 
(This: not null access Ref;
key: DDS.String;
params: access DDS.WriteParams_T);

Get_Key_Value_W_Key 

procedure Get_Key_Value_W_Key 
(This: not null access Ref;
key: DDS.String;
handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Retrieve the instance key that corresponds to an instance handle.


See also: FooDataWriter.get_key_value

CreateTypedI 

function CreateTypedI return DDS.DataWriter.Ref_Access;

DestroyTypedI 

procedure DestroyTypedI 
(Writer: in out DDS.DataWriter.Ref_Access);