interface_i_cellfence_callback.md 2.4 KB
Newer Older
Z
z00524957 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
# ICellfenceCallback


## 概述

定义基站围栏模块的回调函数

用户在开启基站围栏功能前,需要先注册该回调函数。当基站围栏状态发生变化时,会通过回调函数进行上报。 详情可参考[ICellfenceInterface](interface_i_cellfence_interface.md)

**Since:**

4.0

**Since:**

4.0

**相关模块:**

[HdiLpfenceCellfence](_hdi_lpfence_cellfence.md)


## 汇总


### Public 成员函数

  | 名称 | 描述 | 
| -------- | -------- |
| [OnCellfenceChanged](#oncellfencechanged) ([in] struct [CellfenceStatus](_cellfence_status.md) fences) | 定义基站围栏状态变化通知的回调函数。 | 
| [OnGetCellfenceSizeCb](#ongetcellfencesizecb) ([in] struct [CellfenceSize](_cellfence_size.md) size) | 定义基站围栏使用信息的回调函数。 | 
| [OnCellfenceReset](#oncellfencereset) () | 定义低功耗围栏服务复位事件通知的回调函数。 | 


## 成员函数说明


### OnCellfenceChanged()

  
```
ICellfenceCallback::OnCellfenceChanged ([in] struct CellfenceStatus fences)
```

**描述:**

定义基站围栏状态变化通知的回调函数。

设备与基站围栏的状态关系发生变化时,会通过该回调函数进行上报。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| fences | 上报基站围栏变化的状态。详见[CellfenceStatus](_cellfence_status.md)定义。 | 

**返回:**

如果回调函数上报数据成功,则返回0。

如果回调函数上报数据失败,则返回负值。


### OnCellfenceReset()

  
```
ICellfenceCallback::OnCellfenceReset ()
```

**描述:**

定义低功耗围栏服务复位事件通知的回调函数。

低功耗围栏服务发生复位时会通过该回调函数进行事件上报。

**返回:**

如果回调函数调用成功,则返回0。

如果回调函数调用失败,则返回负值。


### OnGetCellfenceSizeCb()

  
```
ICellfenceCallback::OnGetCellfenceSizeCb ([in] struct CellfenceSize size)
```

**描述:**

定义基站围栏使用信息的回调函数。

获取基站围栏使用信息时,会通过该回调函数进行上报。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| size | 基站围栏使用信息。详见[CellfenceSize](_cellfence_size.md)定义。 | 

**返回:**

如果回调函数上报数据成功,则返回0。

如果回调函数上报数据失败,则返回负值。