Skip to content

Latest commit

 

History

History
234 lines (165 loc) · 5.91 KB

EventLoopApi.md

File metadata and controls

234 lines (165 loc) · 5.91 KB
Raw

EventLoopApi

All URIs are relative to http://127.0.0.1:18776/api/v1/module

Method HTTP request Description
addEventLoop POST /event-loop-group/{elg}/event-loop add event-loop into event-loop-group
describeEventLoop GET /event-loop-group/{elg}/event-loop/{el}/detail get detailed info of one event-loop in event-loop-group
getEventLoop GET /event-loop-group/{elg}/event-loop/{el} get event-loop in event-loop-group
listEventLoop GET /event-loop-group/{elg}/event-loop retrieve event-loop list from event-loop-group
removeEventLoop DELETE /event-loop-group/{elg}/event-loop/{el} remove event-loop from event-loop-group

addEventLoop

addEventLoop(elg, body)

add event-loop into event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopApi;


EventLoopApi apiInstance = new EventLoopApi();
String elg = "elg_example"; // String | name of the event-loop-group
EventLoopCreate body = new EventLoopCreate(); // EventLoopCreate | 
try {
    apiInstance.addEventLoop(elg, body);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopApi#addEventLoop");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group
body EventLoopCreate

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

describeEventLoop

EventLoopDetail describeEventLoop(elg, el)

get detailed info of one event-loop in event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopApi;


EventLoopApi apiInstance = new EventLoopApi();
String elg = "elg_example"; // String | name of the event-loop-group
String el = "el_example"; // String | name of the event-loop
try {
    EventLoopDetail result = apiInstance.describeEventLoop(elg, el);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopApi#describeEventLoop");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group
el String name of the event-loop

Return type

EventLoopDetail

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getEventLoop

EventLoop getEventLoop(elg, el)

get event-loop in event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopApi;


EventLoopApi apiInstance = new EventLoopApi();
String elg = "elg_example"; // String | name of the event-loop-group
String el = "el_example"; // String | name of the event-loop
try {
    EventLoop result = apiInstance.getEventLoop(elg, el);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopApi#getEventLoop");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group
el String name of the event-loop

Return type

EventLoop

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listEventLoop

List<EventLoop> listEventLoop(elg)

retrieve event-loop list from event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopApi;


EventLoopApi apiInstance = new EventLoopApi();
String elg = "elg_example"; // String | name of the event-loop-group
try {
    List<EventLoop> result = apiInstance.listEventLoop(elg);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopApi#listEventLoop");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group

Return type

List<EventLoop>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeEventLoop

removeEventLoop(elg, el)

remove event-loop from event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopApi;


EventLoopApi apiInstance = new EventLoopApi();
String elg = "elg_example"; // String | name of the event-loop-group
String el = "el_example"; // String | name of the event-loop
try {
    apiInstance.removeEventLoop(elg, el);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopApi#removeEventLoop");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group
el String name of the event-loop

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined