oc_dynamic_config.h File Reference

Handles configuration of the Dynamic. More...

#include <oc_stdtypes.h>
#include <oc_1word.h>
#include <oc_errors.h>
#include <oc_time.h>
#include <oc_memory.h>
#include <oc_cfg.h>

Go to the source code of this file.

Data Structures
struct	oC_DynamicConfig_VariableDetails_t
	stores configuration data More...

Macros
#define	oC_CONFIGURATIONS_MODULES_LIST(ADD, DONT_ADD)
#define	oC_CONFIGURATIONS_LIST(ADD, DONT_ADD)
#define	oC_DynamicConfig_Module_(MODULE_NAME)   oC_1WORD_FROM_2( oC_DynamicConfig_Module_, MODULE_NAME )
	creates name of the value with the given module name

Enumerations

Variables
oC_DynamicConfig_VariableDetails_t	oC_DynamicConfig_VariablesDetails [oC_DynamicConfig_VariableId_NumberOfElements]
	array with definitions of variables details

Detailed Description

---

Author

Patryk Kubiak

Note

Copyright (C) 2016 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om

Copyright

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition in file oc_dynamic_config.h.

Macro Definition Documentation

oC_CONFIGURATIONS_LIST	(		ADD,
			DONT_ADD
	)

Value:

ADD( Tcp   , oC_MemorySize_t   , StackSize                 , B(8096)   , "Stack Size"                  , "Default size of the stack for TCP server threads "                       )\
    ADD( Tcp   , uint16_t          , WindowSize                , B(1500)   , "Window Size"                 , "Default size of the window for new TCP connections"                      )\
    ADD( Tcp   , uint8_t           , WindowScale               , 0         , "Window Scale"                , "Default scale of the window for new TCP connections"                     )\
    ADD( Tcp   , oC_Time_t         , ConfirmationTimeout       , ms(500)   , "Confirmation Timeout"        , "Maximum time for the confirmation before retransmission of a packet"     )\
    ADD( Tcp   , oC_Time_t         , WaitForConnectionTimeout  , day(1)    , "WfC Timeout"                 , "Maximum time to wait for new connection"                                 )\
    ADD( Tcp   , oC_Time_t         , DeleteConnectionTimeout   , day(1)    , "Delete Connection Timeout"   , "Maximum time for deleting connections"                                   )\
    ADD( Tcp   , oC_Time_t         , DecisionTimeout           ,  s(1)     , "Decision Timeout"            , "Maximum time for making decision about accepting connection"             )\
    ADD( Tcp   , oC_Time_t         , AcceptConnectionTimeout   ,  s(1)     , "Accept Connection Timeout"   , "Maximum time for accepting connections"                                  )\
    ADD( Tcp   , oC_Time_t         , RejectConnectionTimeout   , ms(500)   , "Reject Connection Timeout"   , "Maximum time for rejecting connections"                                  )\
    ADD( Tcp   , oC_Time_t         , ExpirationTimeout         , min(10)   , "Expiration Timeout"          , "Maximum time without receiving packets"                                  )\
    ADD( Tcp   , oC_Time_t         , SendingAcknowledgeTimeout , ms(0)     , "Sending ACK Timeout"         , "Maximum time to wait for sending ACK message"                            )\
    ADD( Tcp   , oC_Time_t         , ReadSegmentTimeout        , ms(500)   , "Read Segment Timeout"        , "Maximum time to wait for an app to read a received segment"              )\
    ADD( Tcp   , oC_Time_t         , ReceiveTimeout            , ms(500)   , "Receive Timeout"             , "Maximum time to wait for a packet before checking expiration timeout"    )\
    ADD( Tcp   , uint32_t          , InitialSequenceNumber     ,      0    , "ISN"                         , "Initial Sequence Number for new connections"                             )\
    ADD( Tcp   , oC_MemorySize_t   , PacketSize                , B(1024)   , "Packet Size"                 , "Size of a packet used for sending data"                                  )\
    ADD( ExcHan, oC_Time_t         , MemoryEventsLoggingPeriod , min(1)    , "Memory events logging period", "Minimum time to elapse before logging again an event"                    )\
    ADD( Telnet, uint32_t          , MaxConnections            , 5         , "Max Connections"             , "Maximum number of connections over Telnet"                               )\
    ADD( Telnet, oC_Time_t         , StartServerTimeout        , s(3)      , "Start Server Timeout"        , "Maximum time for starting the Telnet server"                             )\
    ADD( Telnet, oC_Time_t         , StopServerTimeout         , s(3)      , "Stop Server Timeout"         , "Maximum time for stopping the Telnet server"                             )\
    ADD( Telnet, oC_Time_t         , DisconnectTimeout         , ms(500)   , "Disconnect Timeout"          , "Maximum time for disconnecting telnet connection"                        )\
    ADD( Telnet, oC_Time_t         , NaglePeriod               , ms(50)    , "Nagle Period"                , "Period of buffering according to the Nagle's Algorithm"                  )\
    ADD( Telnet, oC_Time_t         , NagleMaximumInactiveTime  , ms(500)   , "Max Nagle Inactive Time"     , "Maximum time to wait when Nagle's thread is inactive"                    )\
    ADD( Telnet, oC_Time_t         , NagleSendingTimeout       , ms(200)   , "Nagle Sending Timeout"       , "Maximum time for TCP transmission"                                       )\
    ADD( Telnet, oC_MemorySize_t   , NagleBufferSize           , B(1024)   , "Nagle Buffer Size"           , "Size of the buffer allocated for the Nagle's Algorithm"                  )\
    ADD( Telnet, oC_MemorySize_t   , NagleThreadStackSize      , B(2048)   , "Nagle Thread Stack Size"     , "Size of the stack of the Nagle's Algorithm thread"                       )\

List with configuration variables definitions. To add new use:

 ADD( MODULE_NAME, TYPE , VARIABLE_NAME, DEFAULT_VALUE, FRIENDLY_NAME, BRIEF  )\

Definition at line 63 of file oc_dynamic_config.h.

#define oC_CONFIGURATIONS_MODULES_LIST	(		ADD,
			DONT_ADD
	)

Value:

ADD( Tcp    , "Tcp" )\
    ADD( ExcHan , "Exception Handler" )\
    ADD( Telnet , "Telnet" )\

List with definitions of configuration modules. To add new use: ADD( MODULE_NAME, FRIENDLY_STRING )\

Definition at line 50 of file oc_dynamic_config.h.