| #ifndef HIDL_GENERATED_ANDROID_HARDWARE_TETHEROFFLOAD_CONTROL_V1_0_IOFFLOADCONTROL_H |
| #define HIDL_GENERATED_ANDROID_HARDWARE_TETHEROFFLOAD_CONTROL_V1_0_IOFFLOADCONTROL_H |
| |
| #include <android/hardware/tetheroffload/control/1.0/ITetheringOffloadCallback.h> |
| #include <android/hidl/base/1.0/IBase.h> |
| |
| #include <android/hidl/manager/1.0/IServiceNotification.h> |
| |
| #include <hidl/HidlSupport.h> |
| #include <hidl/MQDescriptor.h> |
| #include <hidl/Status.h> |
| #include <utils/NativeHandle.h> |
| #include <utils/misc.h> |
| |
| namespace android { |
| namespace hardware { |
| namespace tetheroffload { |
| namespace control { |
| namespace V1_0 { |
| |
| /** |
| * Interface used to control the lifecycle of tethering offload |
| */ |
| struct IOffloadControl : public ::android::hidl::base::V1_0::IBase { |
| /** |
| * Type tag for use in template logic that indicates this is a 'pure' class. |
| */ |
| typedef ::android::hardware::details::i_tag _hidl_tag; |
| |
| /** |
| * Fully qualified interface name: "android.hardware.tetheroffload.control@1.0::IOffloadControl" |
| */ |
| static const char* descriptor; |
| |
| /** |
| * Returns whether this object's implementation is outside of the current process. |
| */ |
| virtual bool isRemote() const override { return false; } |
| |
| /** |
| * Return callback for initOffload |
| */ |
| using initOffload_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Indicates intent to start offload for tethering in immediate future. |
| * |
| * This API must be called exactly once the first time that Tethering is requested by |
| * the user. |
| * |
| * If this API is called multiple times without first calling stopOffload, then the subsequent |
| * calls must fail without changing the state of the server. |
| * |
| * If for some reason, the hardware is currently unable to support offload, this call must fail. |
| * |
| * @param cb Assuming success, this callback must provide unsolicited updates of offload status. |
| * It is assumed to be valid until stopOffload is called. |
| * |
| * @return success true if initialization is successful, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| * |
| * Remarks: Initializing offload does not imply that any upstreams or downstreams have yet been, |
| * or even will be, chosen. This API is symmetrical with stopOffload. |
| */ |
| virtual ::android::hardware::Return<void> initOffload(const ::android::sp<::android::hardware::tetheroffload::control::V1_0::ITetheringOffloadCallback>& cb, initOffload_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for stopOffload |
| */ |
| using stopOffload_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Indicate desire to tear down all tethering offload. |
| * |
| * Called after tethering is no longer requested by the user. Any remaining offload must |
| * be subsequently torn down by the management process. Upon success, the callback registered |
| * in initOffload must be released, and offload must be stopped. |
| * |
| * @return success true if offload is stopped, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| * |
| * Remarks: Statistics must be reset by this API. |
| */ |
| virtual ::android::hardware::Return<void> stopOffload(stopOffload_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for setLocalPrefixes |
| */ |
| using setLocalPrefixes_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Instruct management process not to forward traffic destined to or from the specified prefixes. |
| * |
| * This API may only be called after initOffload and before stopOffload. |
| * |
| * @param prefixes List containing fully specified prefixes. For e.g. 192.168.1.12/24 |
| * or 2001:4860:0684:0:0:0:0:0:1002/64 |
| * |
| * @return success true if success, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| * |
| * Remarks: This list overrides any previously specified list |
| */ |
| virtual ::android::hardware::Return<void> setLocalPrefixes(const ::android::hardware::hidl_vec<::android::hardware::hidl_string>& prefixes, setLocalPrefixes_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for getForwardedStats |
| */ |
| using getForwardedStats_cb = std::function<void(uint64_t rxBytes, uint64_t txBytes)>; |
| /** |
| * Query offloaded traffic statistics forwarded to an upstream address. |
| * |
| * Return statistics that have transpired since the last query. This would include |
| * statistics from all offloaded downstream tether interfaces that have been forwarded to this |
| * upstream interface. After returning the statistics, the counters are reset to zero. |
| * |
| * Only offloaded statistics must be returned by this API, software stats must not be |
| * returned. |
| * |
| * @param upstream Upstream interface on which traffic exited/entered |
| * |
| * @return rxBytes values depicting the received bytes |
| * @return txBytes values depicting the transmitted bytes |
| */ |
| virtual ::android::hardware::Return<void> getForwardedStats(const ::android::hardware::hidl_string& upstream, getForwardedStats_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for setDataLimit |
| */ |
| using setDataLimit_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Instruct hardware to stop forwarding traffic and send a callback after limit bytes have been |
| * transferred in either direction on this upstream interface. |
| * |
| * The limit must be applied to all traffic on the given upstream interface. This |
| * includes hardware forwarded traffic, software forwarded traffic, and AP-originated traffic. |
| * IPv4 and IPv6 traffic both count towards the same limit. IP headers are included in the |
| * byte count limit, but, link-layer headers are not. |
| * |
| * This API may only be called while offload is occurring on this upstream. The hardware |
| * management process is not expected to cache the value and apply the quota once offload is |
| * started. This cache is not expected, because the limit value would likely become stale over |
| * time and would not reflect any new traffic that has occurred. |
| * |
| * This limit must replace any previous limit. It may be interpreted as "tell me when |
| * <limit> bytes have been transferred (in either direction) on <upstream>, starting |
| * now and counting from zero." |
| * |
| * Once the limit is reached, the callback registered in initOffload must be called to indicate |
| * this event and all offload must be stopped. If offload is desired again, the hardware |
| * management process must be completely reprogrammed by calling setUpstreamParameters and |
| * addDownstream again. Note that it is not necessary to call initOffload again to resume offload |
| * if stopOffload was not called by the client. |
| * |
| * @param upstream Upstream interface name that limit must apply to |
| * @param limit Bytes limit that can occur before action must be taken |
| * |
| * @return success true if limit is applied, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| */ |
| virtual ::android::hardware::Return<void> setDataLimit(const ::android::hardware::hidl_string& upstream, uint64_t limit, setDataLimit_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for setUpstreamParameters |
| */ |
| using setUpstreamParameters_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Instruct hardware to start forwarding traffic to the specified upstream. |
| * |
| * When iface, v4Addr, and v4Gw are all non-null, the management process may begin forwarding |
| * any currently configured or future configured IPv4 downstreams to this upstream interface. |
| * |
| * If any of the previously three mentioned parameters are null, then any current IPv4 offload |
| * must be stopped. |
| * |
| * When iface and v6Gws are both non-null, and in the case of v6Gws, are not empty, the |
| * management process may begin forwarding any currently configured or future configured IPv6 |
| * downstreams to this upstream interface. |
| * |
| * If either of the two above parameters are null, or no V6 Gateways are provided, then IPv6 |
| * offload must be stopped. |
| * |
| * This API may only be called after initOffload and before stopOffload. |
| * |
| * @param iface Upstream interface name. Note that only one is needed because IPv4 and IPv6 |
| * interfaces cannot be different (only known that this can occur during software |
| * xlat, which cannot be offloaded through hardware anyways). If the iface is |
| * null, offload must be stopped. |
| * @param v4Addr The local IPv4 address assigned to the provided upstream interface, i.e. the |
| * IPv4 address the packets are NATed to. For e.g. 192.168.1.12. |
| * @param v4Gw The IPv4 address of the IPv4 gateway on the upstream interface. |
| * For e.g. 192.168.1.1 |
| * @param v6Gws A list of IPv6 addresses (for e.g. 2001:4860:0684:0:0:0:0:0:1002) for possible |
| * IPv6 gateways on the upstream interface. |
| * |
| * @return success true if success, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| * |
| * Remarks: This overrides any previously configured parameters. |
| */ |
| virtual ::android::hardware::Return<void> setUpstreamParameters(const ::android::hardware::hidl_string& iface, const ::android::hardware::hidl_string& v4Addr, const ::android::hardware::hidl_string& v4Gw, const ::android::hardware::hidl_vec<::android::hardware::hidl_string>& v6Gws, setUpstreamParameters_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for addDownstream |
| */ |
| using addDownstream_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Configure a downstream interface and prefix in the hardware management process that may be |
| * forwarded. |
| * |
| * The prefix may be an IPv4 or an IPv6 address to signify which family can be offloaded from the |
| * specified tether interface. The list of IPv4 and IPv6 downstreams that are configured may |
| * differ. |
| * |
| * If the given protocol, as determined by the prefix, has an upstream set, |
| * the hardware may begin forwarding traffic between the upstream and any devices on the |
| * downstream interface that have IP addresses within the specified prefix. Traffic from the same |
| * downstream interfaces is unaffected and must be forwarded if and only if it was already |
| * being forwarded. |
| * |
| * If no upstream is currently configured, then these downstream interface and prefixes must be |
| * preserved so that offload may begin in the future when an upstream is set. |
| * |
| * This API does not replace any previously configured downstreams and must be explictly removed |
| * by calling removeDownstream. |
| * |
| * This API may only be called after initOffload and before stopOffload. |
| * |
| * @param iface Tether interface |
| * @param prefix Downstream prefix depicting addresses that may be offloaded. |
| * For e.g. 192.168.1.12/24 or 2001:4860:0684::/64) |
| * |
| * @return success true if success, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| * |
| * Remarks: The hardware management process may fail this call in a normal situation. This can |
| * happen because the hardware cannot support the current number of prefixes, the |
| * hardware cannot support concurrent offload on multiple interfaces, the hardware |
| * cannot currently support offload on the tether interface for some reason, or any |
| * other dynamic configuration issues which may occur. In this case, |
| * traffic must remain unaffected and must be forwarded if and only if it was already |
| * being forwarded. |
| */ |
| virtual ::android::hardware::Return<void> addDownstream(const ::android::hardware::hidl_string& iface, const ::android::hardware::hidl_string& prefix, addDownstream_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for removeDownstream |
| */ |
| using removeDownstream_cb = std::function<void(bool success, const ::android::hardware::hidl_string& errMsg)>; |
| /** |
| * Remove a downstream prefix that may be forwarded from the hardware management process. |
| * |
| * The prefix may be an IPv4 or an IPv6 address. If it was not previously configured using |
| * addDownstream, then this must be a no-op. |
| * |
| * This API may only be called after initOffload and before stopOffload. |
| * |
| * @param iface Tether interface |
| * @param prefix Downstream prefix depicting address that must no longer be offloaded |
| * For e.g. 192.168.1.12/24 or 2001:4860:0684::/64) |
| * |
| * @return success true if success, false otherwise |
| * @return errMsg a human readable string if eror has occured. |
| */ |
| virtual ::android::hardware::Return<void> removeDownstream(const ::android::hardware::hidl_string& iface, const ::android::hardware::hidl_string& prefix, removeDownstream_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for interfaceChain |
| */ |
| using interfaceChain_cb = std::function<void(const ::android::hardware::hidl_vec<::android::hardware::hidl_string>& descriptors)>; |
| /* |
| * Provides run-time type information for this object. |
| * For example, for the following interface definition: |
| * package android.hardware.foo@1.0; |
| * interface IParent {}; |
| * interface IChild extends IParent {}; |
| * Calling interfaceChain on an IChild object must yield the following: |
| * ["android.hardware.foo@1.0::IChild", |
| * "android.hardware.foo@1.0::IParent" |
| * "android.hidl.base@1.0::IBase"] |
| * |
| * @return descriptors a vector of descriptors of the run-time type of the |
| * object. |
| */ |
| virtual ::android::hardware::Return<void> interfaceChain(interfaceChain_cb _hidl_cb) override; |
| |
| /* |
| * Emit diagnostic information to the given file. |
| * |
| * Optionally overriden. |
| * |
| * @param fd File descriptor to dump data to. |
| * Must only be used for the duration of this call. |
| * @param options Arguments for debugging. |
| * Must support empty for default debug information. |
| */ |
| virtual ::android::hardware::Return<void> debug(const ::android::hardware::hidl_handle& fd, const ::android::hardware::hidl_vec<::android::hardware::hidl_string>& options) override; |
| |
| /** |
| * Return callback for interfaceDescriptor |
| */ |
| using interfaceDescriptor_cb = std::function<void(const ::android::hardware::hidl_string& descriptor)>; |
| /* |
| * Provides run-time type information for this object. |
| * For example, for the following interface definition: |
| * package android.hardware.foo@1.0; |
| * interface IParent {}; |
| * interface IChild extends IParent {}; |
| * Calling interfaceDescriptor on an IChild object must yield |
| * "android.hardware.foo@1.0::IChild" |
| * |
| * @return descriptor a descriptor of the run-time type of the |
| * object (the first element of the vector returned by |
| * interfaceChain()) |
| */ |
| virtual ::android::hardware::Return<void> interfaceDescriptor(interfaceDescriptor_cb _hidl_cb) override; |
| |
| /** |
| * Return callback for getHashChain |
| */ |
| using getHashChain_cb = std::function<void(const ::android::hardware::hidl_vec<::android::hardware::hidl_array<uint8_t, 32>>& hashchain)>; |
| /* |
| * Returns hashes of the source HAL files that define the interfaces of the |
| * runtime type information on the object. |
| * For example, for the following interface definition: |
| * package android.hardware.foo@1.0; |
| * interface IParent {}; |
| * interface IChild extends IParent {}; |
| * Calling interfaceChain on an IChild object must yield the following: |
| * [(hash of IChild.hal), |
| * (hash of IParent.hal) |
| * (hash of IBase.hal)]. |
| * |
| * SHA-256 is used as the hashing algorithm. Each hash has 32 bytes |
| * according to SHA-256 standard. |
| * |
| * @return hashchain a vector of SHA-1 digests |
| */ |
| virtual ::android::hardware::Return<void> getHashChain(getHashChain_cb _hidl_cb) override; |
| |
| /* |
| * This method trigger the interface to enable/disable instrumentation based |
| * on system property hal.instrumentation.enable. |
| */ |
| virtual ::android::hardware::Return<void> setHALInstrumentation() override; |
| |
| /* |
| * Registers a death recipient, to be called when the process hosting this |
| * interface dies. |
| * |
| * @param recipient a hidl_death_recipient callback object |
| * @param cookie a cookie that must be returned with the callback |
| * @return success whether the death recipient was registered successfully. |
| */ |
| virtual ::android::hardware::Return<bool> linkToDeath(const ::android::sp<::android::hardware::hidl_death_recipient>& recipient, uint64_t cookie) override; |
| |
| /* |
| * Provides way to determine if interface is running without requesting |
| * any functionality. |
| */ |
| virtual ::android::hardware::Return<void> ping() override; |
| |
| /** |
| * Return callback for getDebugInfo |
| */ |
| using getDebugInfo_cb = std::function<void(const ::android::hidl::base::V1_0::DebugInfo& info)>; |
| /* |
| * Get debug information on references on this interface. |
| * @return info debugging information. See comments of DebugInfo. |
| */ |
| virtual ::android::hardware::Return<void> getDebugInfo(getDebugInfo_cb _hidl_cb) override; |
| |
| /* |
| * This method notifies the interface that one or more system properties |
| * have changed. The default implementation calls |
| * (C++) report_sysprop_change() in libcutils or |
| * (Java) android.os.SystemProperties.reportSyspropChanged, |
| * which in turn calls a set of registered callbacks (eg to update trace |
| * tags). |
| */ |
| virtual ::android::hardware::Return<void> notifySyspropsChanged() override; |
| |
| /* |
| * Unregisters the registered death recipient. If this service was registered |
| * multiple times with the same exact death recipient, this unlinks the most |
| * recently registered one. |
| * |
| * @param recipient a previously registered hidl_death_recipient callback |
| * @return success whether the death recipient was unregistered successfully. |
| */ |
| virtual ::android::hardware::Return<bool> unlinkToDeath(const ::android::sp<::android::hardware::hidl_death_recipient>& recipient) override; |
| |
| // cast static functions |
| /** |
| * This performs a checked cast based on what the underlying implementation actually is. |
| */ |
| static ::android::hardware::Return<::android::sp<::android::hardware::tetheroffload::control::V1_0::IOffloadControl>> castFrom(const ::android::sp<::android::hardware::tetheroffload::control::V1_0::IOffloadControl>& parent, bool emitError = false); |
| /** |
| * This performs a checked cast based on what the underlying implementation actually is. |
| */ |
| static ::android::hardware::Return<::android::sp<::android::hardware::tetheroffload::control::V1_0::IOffloadControl>> castFrom(const ::android::sp<::android::hidl::base::V1_0::IBase>& parent, bool emitError = false); |
| |
| // helper methods for interactions with the hwservicemanager |
| /** |
| * This gets the service of this type with the specified instance name. If the |
| * service is currently not available or not in the VINTF manifest on a Trebilized |
| * device, this will return nullptr. This is useful when you don't want to block |
| * during device boot. If getStub is true, this will try to return an unwrapped |
| * passthrough implementation in the same process. This is useful when getting an |
| * implementation from the same partition/compilation group. |
| * |
| * In general, prefer getService(std::string,bool) |
| */ |
| static ::android::sp<IOffloadControl> tryGetService(const std::string &serviceName="default", bool getStub=false); |
| /** |
| * Deprecated. See tryGetService(std::string, bool) |
| */ |
| static ::android::sp<IOffloadControl> tryGetService(const char serviceName[], bool getStub=false) { std::string str(serviceName ? serviceName : ""); return tryGetService(str, getStub); } |
| /** |
| * Deprecated. See tryGetService(std::string, bool) |
| */ |
| static ::android::sp<IOffloadControl> tryGetService(const ::android::hardware::hidl_string& serviceName, bool getStub=false) { std::string str(serviceName.c_str()); return tryGetService(str, getStub); } |
| /** |
| * Calls tryGetService("default", bool). This is the recommended instance name for singleton services. |
| */ |
| static ::android::sp<IOffloadControl> tryGetService(bool getStub) { return tryGetService("default", getStub); } |
| /** |
| * This gets the service of this type with the specified instance name. If the |
| * service is not in the VINTF manifest on a Trebilized device, this will return |
| * nullptr. If the service is not available, this will wait for the service to |
| * become available. If the service is a lazy service, this will start the service |
| * and return when it becomes available. If getStub is true, this will try to |
| * return an unwrapped passthrough implementation in the same process. This is |
| * useful when getting an implementation from the same partition/compilation group. |
| */ |
| static ::android::sp<IOffloadControl> getService(const std::string &serviceName="default", bool getStub=false); |
| /** |
| * Deprecated. See getService(std::string, bool) |
| */ |
| static ::android::sp<IOffloadControl> getService(const char serviceName[], bool getStub=false) { std::string str(serviceName ? serviceName : ""); return getService(str, getStub); } |
| /** |
| * Deprecated. See getService(std::string, bool) |
| */ |
| static ::android::sp<IOffloadControl> getService(const ::android::hardware::hidl_string& serviceName, bool getStub=false) { std::string str(serviceName.c_str()); return getService(str, getStub); } |
| /** |
| * Calls getService("default", bool). This is the recommended instance name for singleton services. |
| */ |
| static ::android::sp<IOffloadControl> getService(bool getStub) { return getService("default", getStub); } |
| /** |
| * Registers a service with the service manager. For Trebilized devices, the service |
| * must also be in the VINTF manifest. |
| */ |
| __attribute__ ((warn_unused_result))::android::status_t registerAsService(const std::string &serviceName="default"); |
| /** |
| * Registers for notifications for when a service is registered. |
| */ |
| static bool registerForNotifications( |
| const std::string &serviceName, |
| const ::android::sp<::android::hidl::manager::V1_0::IServiceNotification> ¬ification); |
| }; |
| |
| // |
| // type declarations for package |
| // |
| |
| static inline std::string toString(const ::android::sp<::android::hardware::tetheroffload::control::V1_0::IOffloadControl>& o); |
| |
| // |
| // type header definitions for package |
| // |
| |
| static inline std::string toString(const ::android::sp<::android::hardware::tetheroffload::control::V1_0::IOffloadControl>& o) { |
| std::string os = "[class or subclass of "; |
| os += ::android::hardware::tetheroffload::control::V1_0::IOffloadControl::descriptor; |
| os += "]"; |
| os += o->isRemote() ? "@remote" : "@local"; |
| return os; |
| } |
| |
| |
| } // namespace V1_0 |
| } // namespace control |
| } // namespace tetheroffload |
| } // namespace hardware |
| } // namespace android |
| |
| // |
| // global type declarations for package |
| // |
| |
| |
| #endif // HIDL_GENERATED_ANDROID_HARDWARE_TETHEROFFLOAD_CONTROL_V1_0_IOFFLOADCONTROL_H |
