C3/Src/ChannelLinter
Grzegorz Rychlik edf08555d9 Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
..
AppConfig.hpp Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
ArgumentParser.cpp Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
ArgumentParser.h Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
ChannelLinter.cpp Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
ChannelLinter.h Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
ChannelLinter.vcxproj Add doxygen comments 2019-11-18 14:42:23 +01:00
ChannelLinter.vcxproj.filters Add doxygen comments 2019-11-18 14:42:23 +01:00
ChannelLinterMain.cpp Add doxygen comments 2019-11-18 14:42:23 +01:00
Form.cpp Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
Form.h Add missing Doxy, minor style changes 2019-11-25 12:22:41 +01:00
FormElement.cpp Add doxygen comments 2019-11-18 14:42:23 +01:00
FormElement.h Add doxygen comments 2019-11-18 14:42:23 +01:00
MockDeviceBridge.cpp Implement MockDeviceBridge::Close 2019-11-18 14:42:22 +01:00
MockDeviceBridge.h Add doxygen comments 2019-11-18 14:42:23 +01:00
README.md Add Readme 2019-11-18 14:42:23 +01:00
StdAfx.h Refactor Form and FormElement 2019-11-18 14:42:23 +01:00
Stdafx.cpp Create stub for C3 channel linter 2019-11-18 14:42:21 +01:00
argparse.hpp Refactor the application object 2019-11-18 14:42:22 +01:00

README.md

C3 Channel Linter

Standalone tool to ease the development and debugging of channels.

Usage

This tool provides console frontend for real channel usage

  1. Parse the json returned from GetCapability() and validate it against C3 rules: -n ChannelName --name ChannelName e.g. ChannelLinter.exe -n UncShareFile Note: ChannelName is case sensitive and must be same as used for the class name.
  2. Create instance of a channel: -a [Argument1 Argument2 ...] --args [Argument1 Argument2 ...] e.g. ChannelLinter.exe -n UncShareFile --args inputId outputId C:\Temp\C3Store false Note: Messeges logged by calls to this->Log() will not be displayed if the channel constructor throws.
  3. Test channel permeability - create a complemetary pair of channels and send message through. -i --test-io e.g. ChannelLinter.exe -n UncShareFile --args inputId outputId C:\Temp\C3Store false -i
  4. Execute channel commmand: -x commandId [Argument1 Argument2 ...] --command commandId [Argument1 Argument2 ...] e.g. ChannelLinter.exe -n UncShareFile --args inputId outputId C:\Temp\C3Store false -x 0