Skip to content

feat!: Remove socom::Runtime::subscribe find service() #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lurtz wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

feat!: Remove socom::Runtime::subscribe find service() #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4efade1
initial removal of subscribe_find_service
lurtz Apr 21, 2026
2f683b2
more test cleanup
lurtz Apr 21, 2026
d2808ad
remove some subscribe_find_service from docs
lurtz Apr 21, 2026
d990091
improved diagram
lurtz Apr 21, 2026
8e642ef
Remove find_service from documentation
lurtz Apr 21, 2026
36a1fa6
Merge branch 'main' into remove-socom-subscribe_find_service
lurtz Apr 22, 2026
de7576e
Merge branch 'main' into remove-socom-subscribe_find_service
lurtz Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions src/socom/doc/design/40_behavioral_view.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,6 @@ Consequently, update_event() satisfies the event update request implicitly.
include::models/interaction_diagram_field_notification_communication.puml[]
....

== Service Gateway - find service

The creation of client connectors is forwarded to bridges as request_service() calls.
Service bridges look up the required service instance within their domain.
If available, they connect to the remote counterpart and locally create a proxy server connector (forwarding all communication).

.Interaction diagram: Service Gateway - find service
[plantuml, svg, align="center"]
....
include::models/interaction_diagram_service_gateway_find_service.puml[]
....

== Service Gateway - require service

The creation of client connectors is forwarded to bridges as request_service() calls.
Expand All @@ -127,9 +115,9 @@ include::models/interaction_diagram_service_gateway_require_service.puml[]

== Service Gateway - provide service

The creation of server connectors is found by service bridges using the SOCom subscribe_find_service() API.
The creation of server connectors is found by service bridges using the client connector Service_state_change_callback.
Service bridges provide this information within their domain.
If any domain partner requests the service instance, the service bridge creates a proxy client connector (forwarding all communication).
If any domain partner requests the service instance, the service bridge forwards all communication using this proxy client connector.

.Interaction diagram: Service Gateway - provide service
[plantuml, svg, align="center"]
Expand Down
88 changes: 0 additions & 88 deletions src/socom/doc/design/models/interaction_diagram_service_gateway_find_service.puml
View file
Open in desktop

This file was deleted.

64 changes: 28 additions & 36 deletions src/socom/doc/design/models/interaction_diagram_service_gateway_provide_service.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,54 +25,23 @@ activate socom
app -> bridge ** : create_bridge_component()
activate bridge

bridge -> socom : register_service_bridge(bridge_subscribe_find_service, bridge_request_service)
bridge -> socom : register_service_bridge(bridge_request_service)
activate socom
return

bridge -> socom : subscribe_find_service(bridge_find_callback)
activate socom
return

note right
A generic service bridge (e.g. bridge::ipc)
is interested in every service instance
within the local process.
This enables a config-free (dynamic)
implementation of service discovery functionality
based on the pure internal service instance identifiers.
end note


== Application creates a service instance ==

app -> socom : make_server_connector(interface_A, instance_1)
activate socom
socom -> bridge : bridge_find_callback(interface_A, instance_1, State::added)
activate bridge

group Implementation detail
bridge -> bridge
note right
The generic service bridge
informs its remote counterparts
about the availability
of a new service instance
interface_A, instance_1
at the local endpoint.
To get information about services the
bridge needs to create a client connector.
end note
end
return

return

== service instance remote usage ==

group Implementation detail
bridge -> bridge
note right
A remote counterpart is interested
in the local service and informed the
generic service bridge about.
in a service and informed the
service bridge about.
end note
end

Expand All @@ -88,8 +57,31 @@ only if service instance is locally not available.
end note
end

== Application creates a service instance ==

app -> socom : make_server_connector(interface_A, instance_1)
activate socom
socom -> socom
note right
SOCom connects client_connector to server_connector.
end note

socom -> bridge : Client_connector::Service_state_change_callback(Service_state::available)
activate bridge

group Implementation detail
bridge -> bridge
note right
The generic service bridge
informs its remote counterparts
about the availability
of a new service instance
interface_A, instance_1
at the local endpoint.
end note
end
return

return

@enduml
15 changes: 3 additions & 12 deletions src/socom/doc/design/models/interaction_diagram_service_gateway_require_service.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,15 @@ activate socom
app -> bridge ** : create_bridge_component()
activate bridge

bridge -> socom : register_service_bridge\n(bridge_subscribe_find_service, bridge_request_service)
activate socom
return

bridge -> socom : subscribe_find_service(bridge_find_callback)
bridge -> socom : register_service_bridge(bridge_request_service)
activate socom
return

note right
A generic service bridge (e.g. bridge::ipc)
is interested in every service instance
within the local process.
This enables a config-free (dynamic)
implementation of service discovery functionality
based on the pure internal service instance identifiers.
To get information about services the
bridge needs to create a client connector.
end note


== Application requests a service instance ==

app -> socom : make_client_connector(interface_A, instance_1)
Expand Down
108 changes: 1 addition & 107 deletions src/socom/include/score/socom/runtime.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,11 @@

#include <functional>
#include <memory>
#include <optional>
#include <score/socom/client_connector.hpp>
#include <score/socom/error.hpp>
#include <score/socom/posix_credentials.hpp>
#include <score/socom/server_connector.hpp>
#include <score/socom/service_interface_identifier.hpp>
#include <vector>

namespace score::socom {

Expand Down Expand Up @@ -60,19 +58,6 @@ inline bool operator!=(Bridge_identity const& lhs, Bridge_identity const& rhs) {
return !(lhs == rhs);
}

/// \brief Interface class for Find_subscription RAII type (see Runtime).
class Find_subscription_handle {
public:
Find_subscription_handle() = default;
virtual ~Find_subscription_handle() = default;

Find_subscription_handle(Find_subscription_handle const&) = delete;
Find_subscription_handle(Find_subscription_handle&&) = delete;

Find_subscription_handle& operator=(Find_subscription_handle const&) = delete;
Find_subscription_handle& operator=(Find_subscription_handle&&) = delete;
};

/// \brief Interface class for Service_bridge_registration RAII type (see Runtime).
class Service_bridge_registration_handle {
public:
Expand Down Expand Up @@ -104,38 +89,13 @@ class Service_request_handle {
Service_request_handle& operator=(Service_request_handle&&) = delete;
};

/// \brief RAII object that represents an active find service subscription, see
/// Runtime::subscribe_find_service().
using Find_subscription = std::unique_ptr<Find_subscription_handle>;
/// \brief RAII object that represents a service bridge registration at the runtime, see
/// Runtime::register_service_bridge()
using Service_bridge_registration = std::unique_ptr<Service_bridge_registration_handle>;
/// \brief RAII object that represents an service request from the runtime to a service bridge, see
/// Runtime::register_service_bridge().
using Service_request = std::unique_ptr<Service_request_handle>;

/// \brief [[deprecated]] Find service result type, see Runtime::subscribe_find_service().
using Find_result_container = std::vector<Service_instance>;

/// \brief Status of reported service.
enum class Find_result_status : std::uint8_t {
added, ///< A new service is found.
deleted ///< A service is removed.
};

/// \brief [[deprecated]] Find service result indication callback type, see
/// Runtime::subscribe_find_service().
using Find_result_callback = std::function<void(Find_result_container const& result)>;

/// \brief Find service result indication callback type, see Runtime::subscribe_find_service().
using Find_result_change_callback = std::function<void(
Service_interface_identifier const&, Service_instance const&, Find_result_status)>;

/// \brief Subscribe_find_service interface type signature.
using Subscribe_find_service_function = std::function<Find_subscription(
Find_result_change_callback, Service_interface_identifier const&,
std::optional<Service_instance>)>;

/// \brief Request_service interface type signature.
using Request_service_function =
std::function<Service_request(Service_interface_definition const&, Service_instance const&)>;
Expand Down Expand Up @@ -245,80 +205,14 @@ class Runtime {
Disabled_server_connector::Callbacks callbacks,
Posix_credentials const& credentials) noexcept = 0;

/// \brief Offers the same functionality as the subscribe_find_service() below.
/// \details The complete list of currently available services is passed into the callback on
/// every change.
///
/// If the set of known services matching the parameters interface and instance changes compared
/// to the last invocation of callback on_result_set, on_result_set is called with the complete
/// list of currently available services.
/// \param on_result_set_change Callback function.
/// \param interface Service interface.
/// \param instance Optional service instance.
/// \return Object that represents an active find service subscription.
[[nodiscard]] [[deprecated(
"Removed due to complexity. Use Client_connectors Service_state_change_callback instead.")]]
virtual Find_subscription subscribe_find_service(
Find_result_callback on_result_set_change, Service_interface_identifier const& interface,
std::optional<Service_instance> instance) noexcept = 0;

/// \brief Calls on_result_change when a new service is found or a service is removed.
/// \note Interface and instance are used to filter for specific services.
/// \details Immediately reports the all currently known service instances matching the given
/// interface and instance to the callback on_result_change and returns a RAII object
/// representing this find subscription.
///
/// If the set of known services matching the parameters interface and instance changes compared
/// to the last invocation of the callback on_result_change, on_result_change is called
/// with the new set of known service instances.
///
/// If the object representing a find subscription is released, then any further changes are no
/// longer indicated through the callback on_result_change.
///
/// If the parameter instance has no value, all instances matching the interface are part of the
/// result.
///
/// If the callback on_result_change is nullptr, find subscription is not performed and the
/// callback on_result_change is never called.
///
/// The method subscribe_find_service(interface, instance) is called on every already registered
/// or later registered bridge and the Service_request RAII objects are stored.
///
/// If the last find service subscription for [interface, instance] is destroyed,
/// subscribe_find_service() deletes all associated find service subscription RAII objects.
///
/// A service bridge contributes to the result-set of find service subscriptions by calling the
/// Find_result_change_callback for the specific bridge which is part of the
/// subscribe_find_service interface. Thus changes on the set of known service instances must be
/// indicated as locally created services. Duplicate services indicate a system configuration
/// error.
///
/// If the one and only find service subscriber is a bridge that indicates the existence of the
/// parameter identity, then no find service request forwarding to the respective bridge
/// is active.
/// \param on_result_change Callback function.
/// \param interface Service interface.
/// \param instance Service instance.
/// \param identity Optional bridge identity.
/// \return Object that represents an active find service subscription.
[[nodiscard]] [[deprecated(
"Removed due to complexity. Use Client_connectors Service_state_change_callback instead.")]]
virtual Find_subscription subscribe_find_service(
Find_result_change_callback on_result_change,
std::optional<Service_interface_identifier> interface,
std::optional<Service_instance> instance,
std::optional<Bridge_identity> identity) noexcept = 0;

/// \brief Registers a bridge which transports events or method calls over an IPC channel.
/// \param identity Bridge identity.
/// \param subscribe_find_service Function to call in order to search for services.
/// \param request_service Function to call if the requested service is not present locally.
/// \return A registration RAII object in case of successful operation, otherwise an error.
/// \note Construction_error::callback_missing is returned if any of the callbacks is not set.
[[nodiscard]]
virtual Result<Service_bridge_registration> register_service_bridge(
Bridge_identity identity, Subscribe_find_service_function subscribe_find_service,
Request_service_function request_service) noexcept = 0;
Bridge_identity identity, Request_service_function request_service) noexcept = 0;
};

/// \brief Function to instantiate a Runtime object.
Expand Down
Loading
Loading