From 8dcf41e9cf2df653ecde7b06ab520f93bb340048 Mon Sep 17 00:00:00 2001 From: Pedro Pinto Date: Fri, 1 Feb 2019 10:08:08 -0500 Subject: [PATCH] Added attach/detach interface proposal. --- src/lib/api/services/OrderService.proto | 1 + src/lib/orderman/core/IOrderServices.h | 105 +++++++++++++++++------- src/lib/orderman/doc/attach_detach.org | 32 ++++++++ 3 files changed, 109 insertions(+), 29 deletions(-) create mode 100644 src/lib/orderman/doc/attach_detach.org diff --git a/src/lib/api/services/OrderService.proto b/src/lib/api/services/OrderService.proto index 4d98fc74b..ee6acddbf 100644 --- a/src/lib/api/services/OrderService.proto +++ b/src/lib/api/services/OrderService.proto @@ -68,6 +68,7 @@ message OrderDefinition { CTICode cti_code = 9; CustomerOrFirm customer_or_firm = 10; OrderSubType sub_type = 12; + repeated uint32 attach_order = 15; CustomOrderDefinition custom_def = 11; } diff --git a/src/lib/orderman/core/IOrderServices.h b/src/lib/orderman/core/IOrderServices.h index c1fc54127..8aaad79de 100644 --- a/src/lib/orderman/core/IOrderServices.h +++ b/src/lib/orderman/core/IOrderServices.h @@ -1,66 +1,113 @@ #pragma once -#include +#include "lib/api/services/OrderService.pb.h" #include "lib/domain_model/common.h" +#include "lib/orderman/actors/order_manager/ChildOrder.h" +#include "lib/orderman/orders/OrderOpResult.h" +#include // fwds namespace bts { -namespace api {namespace orderman { +namespace api { +namespace orderman { class OrderDefinition; class CustomOrderDefinition; class OrderState; class Update; -}} -namespace mercury {class TimerEvent;} +class OrderRecord; +} // namespace orderman +} // namespace api +namespace mercury { +class TimerEvent; +} namespace orderman { class ChildOrder; -class OrderOpResult; +class ISecurityDB; +class IAlgoServices; +class IOrderFactory; class BookUpdateEvent; class TickerUpdateEvent; class SettlementUpdateEvent; class OrderStateUpdateEvent; -}} - +} // namespace orderman +} // namespace bts namespace bts { namespace orderman { template -using Callback = std::function; +using Callback = std::function; +using OrderOpCB = Callback; +OrderOpCB ignore() { + return [](auto &) {}; +}; + +struct AttachOpResult { + OrderOpResult result; + ChildOrder child; +}; + +class AlgoOrder { + public: + virtual void on_init_new(api::orderman::OrderDefinition const &, + ISecurityDB &, IOrderFactory &) = 0; + + virtual void on_activate(Price, Quantity, IAlgoServices &, + OrderOpCB const &) = 0; + + virtual void on_update(Price, Quantity, OrderOpCB const &) = 0; + virtual void on_update(api::orderman::Update const &, + OrderOpCB const &on_result) { + on_result(OrderOpResult{api::orderman::ORDER_ERROR_INVALID_OP, + "Operation not supported"}); + } + + virtual void on_cancel(OrderOpCB const &) = 0; + virtual void on_detach(OrderOpCB const &) = 0; + virtual void on_attached(OrderKey /*new_parent*/) {}; + virtual void on_detached() {} +}; class IOrderServices { -public: + public: // reporting state and definition changes - virtual void report_definition(const api::orderman::CustomOrderDefinition &) = 0; + virtual void + report_definition(const api::orderman::CustomOrderDefinition &) = 0; virtual void report_state(const api::orderman::OrderState &) = 0; // Child order creation/control - virtual void make_child_orders(api::orderman::OrderDefinition const&, size_t how_many, - Callback const&>) = 0; - virtual std::vector make_child_orders(api::orderman::OrderDefinition const&, size_t how_many) = 0; - virtual void activate(ChildOrder&, Price, Quantity,Callback const&) = 0; - virtual void activate(ChildOrder&, Price, Quantity) = 0; - virtual void update(ChildOrder&,Price, Quantity) = 0; - virtual void update(ChildOrder&,Price, Quantity,Callback const&) = 0; - virtual void update(api::orderman::Update const &) = 0; - virtual void update(api::orderman::Update const &,Callback const&) = 0; - virtual void crack(ChildOrder&, Callback const&) = 0; - virtual void crack(ChildOrder&) = 0; - virtual void cancel(ChildOrder&, Callback const&) = 0; - virtual void cancel(ChildOrder&) = 0; + virtual void + make_child_orders(api::orderman::OrderDefinition const &, size_t how_many, + Callback const &>) = 0; + virtual void activate(ChildOrder &, Price, Quantity, + OrderOpCB const & = ignore()) = 0; + virtual void update(ChildOrder &, Price, Quantity, + OrderOpCB const & = ignore()) = 0; + virtual void update(ChildOrder &, api::orderman::Update const &, + OrderOpCB const & = ignore()) = 0; + virtual void cancel(ChildOrder &, OrderOpCB const & = ignore()) = 0; + virtual void attach(OrderKey, Callback const &) = 0; + virtual void detach(ChildOrder const &, OrderOpCB const & = ignore()); // End child control // Events - virtual void subscribe_to_book(SecurityKey,Callback const&) = 0; + virtual void subscribe_to_book(SecurityKey, + Callback const &) = 0; virtual void unsubscribe_from_book(SecurityKey) = 0; - virtual void subscribe_to_ticker(SecurityKey,Callback const&) = 0; + virtual void subscribe_to_ticker(SecurityKey, + Callback const &) = 0; virtual void unsubscribe_from_ticker(SecurityKey) = 0; - virtual void subscribe_to_settlement(SecurityKey, Callback const&) = 0; + virtual void + subscribe_to_settlement(SecurityKey, + Callback const &) = 0; virtual void unsubscribe_from_settlement(SecurityKey) = 0; - virtual void subscribe_to_time(Callback const&) = 0; + virtual void + subscribe_to_time(Callback const &) = 0; virtual void unsubscribe_from_time() = 0; - virtual void subscribe_to_child_updates(Callback const&) = 0; + virtual void + subscribe_to_child_updates(Callback const &) = 0; virtual void unsubscribe_from_child_updates() = 0; // End events }; -}} +} // namespace orderman +} // namespace bts diff --git a/src/lib/orderman/doc/attach_detach.org b/src/lib/orderman/doc/attach_detach.org new file mode 100644 index 000000000..f8ffb58a9 --- /dev/null +++ b/src/lib/orderman/doc/attach_detach.org @@ -0,0 +1,32 @@ +** Attach/Detach semantics +*** Semantics +- An order base definition can include a list of running orders to attach + to +- Each custom definition can have parameters that allow configuration + of the specific order type with respect to the attachment + list. Obvious configuration alternatives are: + - Attach to each of the listed orders directly or + - Forward attachment list to children +- Only orders with no parent or parents in a terminal state can be + attached to +- a detach(order_key) message can be sent to any order, even if that + order was not started through attachment to an existing order. the + expected semantics is for the order in question to stop managing the + child order and transition to completed. + +*** API +- IOrderServices: + - attach_to_order(ok, std::function + on_attach_complete); + - detach(ChildOrder) +- Order + - on_detach(order_key) + - on_attached(); + - on_detached(); +message OrderDefinition { + CTICode cti_code = 9; + CustomerOrFirm customer_or_firm = 10; + OrderSubType sub_type = 12; ++ repeated uint32 attach_to_order = 13; + CustomOrderDefinition custom_def = 11; +}