aboutsummaryrefslogtreecommitdiff
path: root/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/event/EventSnippet.java
blob: 05e044c1427535d1c046881ed61652a2d2b35152 (plain)
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
/*
 * Copyright (C) 2017 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.android.mobly.snippet.event;

import android.support.annotation.Nullable;
import com.google.android.mobly.snippet.Snippet;
import com.google.android.mobly.snippet.rpc.Rpc;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.TimeUnit;
import org.json.JSONException;
import org.json.JSONObject;

public class EventSnippet implements Snippet {
    private static class EventSnippetException extends Exception {
        private static final long serialVersionUID = 1L;

        public EventSnippetException(String msg) {
            super(msg);
        }
    }

    private static final int DEFAULT_TIMEOUT_MILLISECOND = 60 * 1000;
    private final EventCache mEventCache = EventCache.getInstance();

    @Rpc(
            description =
                    "Blocks until an event of a specified type has been received. The returned event is removed from the cache. Default timeout is 60s.")
    public JSONObject eventWaitAndGet(
            String callbackId, String eventName, @Nullable Integer timeout)
            throws InterruptedException, JSONException, EventSnippetException {
        // The server side should never wait forever, so we'll use a default timeout is one is not
        // provided.
        if (timeout == null) {
            timeout = DEFAULT_TIMEOUT_MILLISECOND;
        }
        String qId = EventCache.getQueueId(callbackId, eventName);
        LinkedBlockingDeque<SnippetEvent> q = mEventCache.getEventDeque(qId);
        SnippetEvent result = q.pollFirst(timeout, TimeUnit.MILLISECONDS);
        if (result == null) {
            throw new EventSnippetException("timeout.");
        }
        return result.toJson();
    }

    @Rpc(
            description =
                    "Gets and removes all the events of a certain name that have been received so far. "
                            + "Non-blocking. Potentially racey since it does not guarantee no event of "
                            + "the same name will occur after the call.")
    public List<JSONObject> eventGetAll(String callbackId, String eventName)
            throws InterruptedException, JSONException {
        String qId = EventCache.getQueueId(callbackId, eventName);
        LinkedBlockingDeque<SnippetEvent> q = mEventCache.getEventDeque(qId);
        ArrayList<JSONObject> results = new ArrayList<>(q.size());
        ArrayList<SnippetEvent> buffer = new ArrayList<>(q.size());
        q.drainTo(buffer);
        for (SnippetEvent snippetEvent : buffer) {
            results.add(snippetEvent.toJson());
        }
        if (results.size() == 0) {
            return Collections.emptyList();
        }
        return results;
    }

    @Override
    public void shutdown() {
        mEventCache.clearAll();
    }
}