Click or drag to resize

ShmemInst Class

Provides access to the configurable options for the Shared Memory transport.
Inheritance Hierarchy

Namespace:  OpenDDSharp.OpenDDS.DCPS
Assembly:  OpenDDSharp (in OpenDDSharp.dll) Version: 0.4.1.0
Syntax
public class ShmemInst : TransportInst

The ShmemInst type exposes the following members.

Constructors
  NameDescription
Public methodShmemInst
Creates a new instance of ShmemInst.
Top
Properties
  NameDescription
Public propertyDatalinkControlChunks
The number of chunks used to size allocators for transport control samples. The default value is 32.
(Inherited from TransportInst.)
Public propertyDatalinkControlSize
Size (in bytes) of the control area allocated for each data link. This allocation comes out of the shared-memory pool defined by PoolSize. Defaults to 4 kilobytes.
Public propertyDatalinkReleaseDelay
Delay in milliseconds that the datalink should be released after all associations are removed. The default value is 10 seconds.
(Inherited from TransportInst.)
Public propertyHostName
Gets the host name.
Public propertyIsReliable
Indicates whether the transport is reliable or not.
Public propertyMaxPacketSize
The maximum size of a transport packet, including its transport header, sample header, and sample data. The default value is 2147481599.
(Inherited from TransportInst.)
Public propertyMaxSamplesPerPacket
Maximum number of samples in a transport packet. The default value is 10.
(Inherited from TransportInst.)
Public propertyName
Gets the configuration's name.
(Inherited from TransportInst.)
Public propertyOptimumPacketSize
Optimum size (in bytes) of a packet (packet header + sample(s)). The default value is 4096.
(Inherited from TransportInst.)
Public propertyPoolName
Gets the pool name.
Public propertyPoolSize
Size (in bytes) of the single shared-memory pool allocated by this transport instance. Defaults to 16 megabytes.
Public propertyQueueInitialPools
The initial number of pools for the backpressure queue. The default value is 5.
(Inherited from TransportInst.)
Public propertyQueueMessagesPerPool
Number of pre-created link (list) objects per pool for the "send queue" of each DataLink. The default value is 10.
(Inherited from TransportInst.)
Public propertyThreadPerConnection
Enable or disable the thread per connection send strategy. By default, this option is disabled (false).
(Inherited from TransportInst.)
Public propertyTransportType
Type of the transport; tcp, udp, multicast, shmem, and rtps_udp are included with OpenDDSharp.
(Inherited from TransportInst.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
The shared memory transport type can only provide communication between transport instances on the same host. As part of transport negotiation, if there are multiple transport instances available for communication between hosts, the shared memory transport instances will be skipped so that other types can be used.
See Also