- Generated on Sun Feb 2 2025 21:18:14 for Open Model Railroad Network (OpenMRN) by
1.9.8
|
Open Model Railroad Network (OpenMRN)
|
Go to the source code of this file.
Functions | |
| DECLARE_CONST (nmranet_can_bitrate) | |
| Defines the default bit-rate for CAN devices. | |
| DECLARE_CONST (can2_bitrate) | |
| Defines the default bit-rate for the second CAN device (aka /dev/can1). | |
| DECLARE_CONST (main_thread_priority) | |
| The priority of main thread. | |
| DECLARE_CONST (main_thread_stack_size) | |
| Stack size of main thread. | |
| DECLARE_CONST (executor_select_prescaler) | |
| Prescaler for performing select calls. | |
| DECLARE_CONST (executor_max_sleep_msec) | |
| Max select sleep time (in msec). | |
| DECLARE_CONST (can_tx_buffer_size) | |
| Number of packets to queue in the CANbus device driver for send. | |
| DECLARE_CONST (can_rx_buffer_size) | |
| Number of packets to queue in the CANbus device driver for receive. | |
| DECLARE_CONST (serial_tx_buffer_size) | |
| Number of bytes to queue in the serial driver for send. | |
| DECLARE_CONST (serial_rx_buffer_size) | |
| Number of bytes to queue in the serial driver for receive. | |
| DECLARE_CONST (gridconnect_port_max_incoming_packets) | |
| Number of pending packets per inbound gridconnect port. | |
| DECLARE_CONST (gridconnect_bridge_max_incoming_packets) | |
| Similar to the above, but: | |
| DECLARE_CONST (gridconnect_bridge_max_outgoing_packets) | |
| Number of pending buffers (of type string) in the outgoing hub on a per-connection basis. | |
| DECLARE_CONST (gridconnect_tcp_rcv_buffer_size) | |
| TCP receive buffer size in bytes for gridconnect hubs. | |
| DECLARE_CONST (gridconnect_tcp_snd_buffer_size) | |
| TCP send buffer size in bytes for gridconnect hubs. | |
| DECLARE_CONST (gridconnect_tcp_notsent_lowat_buffer_size) | |
| TCP_NOTSENT_LOWAT kernel parameter (in bytes) for TCP links. | |
| DECLARE_CONST (gridconnect_buffer_size) | |
| Number of bytes of gridconnect data to buffer before sending off the lowlevel system (such as TCP socket). | |
| DECLARE_CONST (gridconnect_buffer_delay_usec) | |
| How long (in microsec) to buffer generated gridconnect data before sending off to the lowlevel system (such as a TCP socket). | |
| DECLARE_CONST (gridconnect_tcp_use_select) | |
| Whether the GridConnect TCP server should use select (single-threaded) or two threads per client (multi-threaded) execution model. | |
| DECLARE_CONST (directhub_port_max_incoming_packets) | |
| Maximum number of packets to parse from a single DirectHubPort before we wait for data to drain from the system. | |
| DECLARE_CONST (directhub_port_incoming_buffer_size) | |
| Number of bytes that we will be reading in one go from an incoming port. | |
| DECLARE_CONST (remote_alias_cache_size) | |
| Number of entries in the remote alias cache. | |
| DECLARE_CONST (local_alias_cache_size) | |
| Number of entries in the local alias cache. | |
| DECLARE_CONST (reserve_unused_alias_count) | |
| Keep this many allocated but unused aliases around. | |
| DECLARE_CONST (local_nodes_count) | |
| Maximum number of local nodes. | |
| DECLARE_CONST (num_datagram_registry_entries) | |
| Number of datagram registry entries. | |
| DECLARE_CONST (num_datagram_clients) | |
| Number of datagram clients. | |
| DECLARE_CONST (num_stream_senders) | |
| Number of stream senders. | |
| DECLARE_CONST (num_memory_spaces) | |
| Maximum number of memory spaces that can be registered for the MemoryConfig datagram handler. | |
| DECLARE_CONST (enable_all_memory_space) | |
| Set to CONSTANT_TRUE if you want to export an "all memory" memory space from the SimpleStack. | |
| DECLARE_CONST (node_init_identify) | |
| Set to CONSTANT_TRUE if you want the nodes to send out producer / consumer identified messages at boot time. | |
| DECLARE_CONST (bulk_alias_num_can_frames) | |
| How many CAN frames should the bulk alias allocator be sending at the same time. | |
| DECLARE_CONST (stream_receiver_default_window_size) | |
| Default number of bytes in maximum stream window size for { StreamReceiver }. | |
| DECLARE_CONST (socket_listener_stack_size) | |
| Stack size for SocketListener threads. | |
| DECLARE_CONST (socket_listener_backlog) | |
| Number of sockets to allow for SocketListener backlog. | |
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file defines configuration options specific to NMRAnet. These options are typcially applied in the same file as appl_main (main.c/main.cxx). For example:
Definition in file nmranet_config.h.
| DECLARE_CONST | ( | can_rx_buffer_size | ) |
Number of packets to queue in the CANbus device driver for receive.
Each packet takes 16 bytes of RAM.
| DECLARE_CONST | ( | can_tx_buffer_size | ) |
Number of packets to queue in the CANbus device driver for send.
Each packet takes 16 bytes of RAM.
| DECLARE_CONST | ( | directhub_port_incoming_buffer_size | ) |
Number of bytes that we will be reading in one go from an incoming port.
We will allocate at least this many bytes dedicated for each input port.
| DECLARE_CONST | ( | executor_max_sleep_msec | ) |
Max select sleep time (in msec).
Executors will sleep at most this much time before checking that something got scheduled on the executor.
| DECLARE_CONST | ( | executor_select_prescaler | ) |
Prescaler for performing select calls.
Executors will run this many Executables (if there is anything scheduled) before two calls to select. This helps in reducing the overhead of the select calls.
| DECLARE_CONST | ( | gridconnect_bridge_max_incoming_packets | ) |
Similar to the above, but:
| DECLARE_CONST | ( | gridconnect_bridge_max_outgoing_packets | ) |
Number of pending buffers (of type string) in the outgoing hub on a per-connection basis.
This limit ensures that we don't leak memory if the output socket cannot send the data fast enough.
| DECLARE_CONST | ( | gridconnect_port_max_incoming_packets | ) |
Number of pending packets per inbound gridconnect port.
There is memory cost associated with setting this number high. Set to 1'000'000 to make it infinite.
| DECLARE_CONST | ( | gridconnect_tcp_notsent_lowat_buffer_size | ) |
TCP_NOTSENT_LOWAT kernel parameter (in bytes) for TCP links.
Used via setsockopt. Set to 1 (default) to not bound it.
| DECLARE_CONST | ( | gridconnect_tcp_rcv_buffer_size | ) |
TCP receive buffer size in bytes for gridconnect hubs.
Used via setsockopt(SO_RCVBUF). Set to 1 (default) to not bound it.
| DECLARE_CONST | ( | gridconnect_tcp_snd_buffer_size | ) |
TCP send buffer size in bytes for gridconnect hubs.
Used via setsockopt(SO_SENDBUF). Set to 1 (default) to not bound it.
| DECLARE_CONST | ( | main_thread_priority | ) |
The priority of main thread.
Used in FreeRTOS. 0 = default priority (middle). Larger number gets the CPU over smaller number. The limit is configMAX_PRIORITIES from FreeRTOSConfig.h
| DECLARE_CONST | ( | main_thread_stack_size | ) |
Stack size of main thread.
Used in FreeRTOS.
| DECLARE_CONST | ( | node_init_identify | ) |
Set to CONSTANT_TRUE if you want the nodes to send out producer / consumer identified messages at boot time.
This is required by the OpenLCB standard.
| DECLARE_CONST | ( | num_datagram_clients | ) |
Number of datagram clients.
This is how many datagram send operations can happen concurrently.
| DECLARE_CONST | ( | num_datagram_registry_entries | ) |
Number of datagram registry entries.
This is how many datagram handlers can be registered (e.g. memory config protocol is one).
| DECLARE_CONST | ( | num_stream_senders | ) |
Number of stream senders.
This is how many stream send operations can happen concurrently.
| DECLARE_CONST | ( | reserve_unused_alias_count | ) |
Keep this many allocated but unused aliases around.
(Currently supported values are 0 or 1.)
1.9.8