minerva package

Subpackages

Submodules

minerva.AppServerManager module

class minerva.AppServerManager.AppServerManager

Bases: minerva.util.Singleton.Singleton

단말앱에게 API 인터페이스 제공

addDeviceGroup(groupId, deviceList)

단말 그룹에 단말을 추가한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

• groupId – 대상 단말 그룹 아이디
• deviceList – 단말 그룹에 추가할 단말 목록 한번에 최대 2000단말 목록까지 포함가능 단말 그룹 내 단말 수는 최대 백만대까지 포함 가능

Returns request_id:  

clearDeviceGroupListener()

앱서버에서 등록한 단말그룹관리 리스너를 해제한다. 이후 리스너의 콜백이 호출되지 않는다.

clearMsgListener()

앱서버에서 등록한 메시지 리스너를 해제한다. 이후 메시지 리스너의 콜백이 호출되지 않는다.

clearRegisterResultListener()

앱서버에서 등록한 단말 등록 리스너를 해제한다. 이후 listener의 콜백이 호출되지 않는다.

createDeviceGroup(groupName, groupDesc, deviceList)

단말 그룹을 생성한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

• groupName – 생성할 단말 그룹명
• groupDesc – 단말 그룹에 대한 설명 - optional 필드로 null입력가능
• deviceList – 단말 그룹 생성시 그룹 내 포함시킬 단말 목록 최대 2000단말 목록까지 포함가능

Returns request_id:  

deleteDeviceGroup(groupId)

단말 그룹을 삭제한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다. :param groupId: 대상 단말 그룹 아이디

Returns request_id:  

registerAppServer(serviceId, regName, gateHost, gatePort)

앱서버를 등록 및 구동한다. 최초 앱서버 등록시 뿐 아니라 이후에도 앱서버 재구동시마다 호출하여 라이브러리가 구동하도록 해야 한다. setRegisterResultListener()로 등록한 AppServerRegisterResultListener의 콜백을 통해 등록 결과를 확인한다. 앱서버 등록 결과는 래셔널아울 콘솔에서도 실시간 확인이 가능하다.

Parameters:

• serviceId – 앱서버가 등록할 대상 고객 서비스의 서비스 아이디
• regName – 앱서버 등록 이름으로 래셔널아울 서비스의 관리자 콘솔에 표시되는 고객 서버의 이름 콘솔에서 앱 서버를 구분하는 역할을 한다.
• gateHost – 고객 앱 서버와 가장 가까운 래셔널아울 게이트서버(ex) seoul1.rationalowl.com
• gatePort – 게이트서버의 포트

Returns request_id:  

sendBroadcastMsg(data, supportMsgQ=False, notiTitle=None, notiMsg=None)

고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

• data – 단말에 전달할 데이터
• supportMsgQ – 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.
• notiTitle – 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자
• notiMsg – 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

Returns request_id:  

sendGroupMsg(data, deviceGroupId, supportMsgQ=False, notiTitle=None, notiMsg=None)

단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

• data – 단말에 전달할 데이터
• deviceGroupId – 단말 그룹 아이디
• supportMsgQ – 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.
• notiTitle – 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자
• notiMsg – 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

Returns request_id:  

sendMulticastMsg(data, deviceRegIds, supportMsgQ=False, notiTitle=None, notiMsg=None)

한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

• data – 단말에 전달할 데이터
• deviceRegIds – 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한
• supportMsgQ – 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.
• notiTitle – 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자
• notiMsg – 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

Returns request_id:  

setDeviceGroupListener(listener: minerva.DeviceGroupListener.DeviceGroupListener)

단말 그룹 관리 API호출후 결과를 처리할 리스너를 등록한다. :param listener: 단말 그룹 관리 API결과를 처리할 리스너

setMsgListener(listener: minerva.MessageListener.MessageListener)

다운스트림 메시지 발신 결과와 업스트림 메시지 수신을 처리할 리스너를 등록한다. :param listener: 다운스트림 메시지 발신 결과와 업스트림 메시지 수신시 처리할 리스너

setRegisterResultListener(listener: minerva.AppServerRegisterResultListener.AppServerRegisterResultListener)

단말 등록 결과를 처리할 리스너를 등록한다.

Parameters:listener – registerAppServer API를 통해 등록요청한 결과를 처리할 리스너 이후 registerAppServer()API 호출시 listener의 onRegisterResult() 콜백에서 결과를 확인한다.

subtractDeviceGroup(groupId, deviceList)

단말 그룹에서 단말을 제거한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

• groupId – 대상 단말 그룹 아이디
• deviceList – 단말 그룹에서 제거할 단말 목록 한번에 최대 2000단말 목록까지 포함가능

Returns request_id:  

terminate()

unregisterAppServer(serviceId, serverRegId)

앱서버를 등록해제한다. setRegisterResultListener()로 등록한 AppServerRegisterResultListener의 콜백을 통해 등록 헤제 결과를 확인한다. 앱서버 등록 해제 결과는 래셔널아울 콘솔에서도 실시간 확인이 가능하다.

Parameters:

• serviceId – 앱서버가 등록할 대상 고객 서비스의 서비스 아이디
• serverRegId – 등록해제할 앱서버 등록 아이디

Returns request_id:  

minerva.AppServerRegisterResultListener module

class minerva.AppServerRegisterResultListener.AppServerRegisterResultListener

Bases: object

onRegisterResult(resultCode, resultMsg, appServerRegId)

onUnregisterResult(resultCode, resultMsg)

minerva.DeviceGroupListener module

class minerva.DeviceGroupListener.DeviceGroupListener

Bases: object

onDeviceGroupAddResult(resultCode, resultMsg, deviceGrpId, totalDeviceSize, addedDeviceSize, failedDevices, requestId)

onDeviceGroupCreateResult(resultCode, resultMsg, deviceGrpId, deviceGrpName, deviceSize, desc, failedDevices, requestId)

onDeviceGroupDeleteResult(resultCode, resultMsg, deviceGrpId, requestId)

onDeviceGroupSubtractResult(resultCode, resultMsg, deviceGrpId, totalDeviceSize, subtractDeviceSize, failedDevices, requestId)

minerva.MessageListener module

class minerva.MessageListener.MessageListener

Bases: object

onSendBroadcastMsgResult(resultCode, resultMsg, requestId)

onSendGroupMsgResult(resultCode, resultMsg, requestId)

onSendMulticastMsgResult(resultCode, resultMsg, requestId)

onSendUnicastMsgResult(resultCode, resultMsg, requestId)

onUpstreamMsgReceived(sender, sendTime, msg)

minerva.Result module

class minerva.Result.Result

Bases: object

RESULT_CHANNEL_ALREADY_CONNECTED = -301

RESULT_CHANNEL_ALREADY_CONNECTED_MSG = '채널이 이미 연결되어 있습니다.'

RESULT_CHANNEL_IS_NOT_AVAILABLE = -302

RESULT_CHANNEL_IS_NOT_AVAILABLE_MSG = '채널이 가용하지 않은 상태입니다.'

RESULT_INVALID_ARGUMENT = -304

RESULT_INVALID_ARGUMENT_MSG = '전달 인자가 잘못되엇습니다.'

RESULT_NETWORK_IS_NOT_AVAILABLE = -303

RESULT_NETWORK_IS_NOT_AVAILABLE_MSG = '네트워크 연결이 끊어져 있습니다.'

RESULT_OK = 1

RESULT_OK_MSG = '작업이 성공 했습니다.'

RESULT_OTHER_SERVER_ALREADY_REGISTERED = -103

RESULT_OTHER_SERVER_ALREADY_REGISTERED_MSG = '이미 다른 App 서버가 등록되었습니다'

RESULT_SERVER_ID_NOT_MATCH = -104

RESULT_SERVER_ID_NOT_MATCH_MSG = '서버 등록ID가 잘못되었습니다.'

RESULT_SERVER_NOT_YET_REGISTERED = -101

RESULT_SERVER_NOT_YET_REGISTERED_MSG = 'App 서버가 아직 등록되지 않았습니다.'

RESULT_SERVER_REGNAME_ALREADY_REGISTERED = -102

RESULT_SERVER_REGNAME_ALREADY_REGISTERED_MSG = '이미 동일한 서버 등록 이름이 동일 서비스내에 존재합니다.'

RESULT_UNKNOWN_ERROR = -1

RESULT_UNKNOWN_ERROR_MSG = '알 수 없는 에러입니다.'

static getResultMessage(resultCode)

Module contents