File: RouteGuideStub.php

package info (click to toggle)
grpc 1.51.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 76,144 kB
  • sloc: cpp: 361,866; python: 72,206; ansic: 37,778; objc: 12,434; ruby: 11,521; sh: 7,652; php: 7,615; makefile: 3,481; xml: 3,246; cs: 1,836; javascript: 1,614; java: 465; pascal: 227; awk: 132
file content (139 lines) | stat: -rw-r--r-- 5,014 bytes parent folder | download | duplicates (4)
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?php
// GENERATED CODE -- DO NOT EDIT!

// Original file comments:
// Copyright 2015 gRPC authors.
//
// 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.
//
namespace Routeguide;

/**
 * Interface exported by the server.
 */
class RouteGuideStub {

    /**
     * A simple RPC.
     *
     * Obtains the feature at a given position.
     *
     * A feature with an empty name is returned if there's no feature at the given
     * position.
     * @param \Routeguide\Point $request client request
     * @param \Grpc\ServerContext $context server request context
     * @return \Routeguide\Feature for response data, null if if error occured
     *     initial metadata (if any) and status (if not ok) should be set to $context
     */
    public function GetFeature(
        \Routeguide\Point $request,
        \Grpc\ServerContext $context
    ): ?\Routeguide\Feature {
        $context->setStatus(\Grpc\Status::unimplemented());
        return null;
    }

    /**
     * A server-to-client streaming RPC.
     *
     * Obtains the Features available within the given Rectangle.  Results are
     * streamed rather than returned at once (e.g. in a response message with a
     * repeated field), as the rectangle may cover a large area and contain a
     * huge number of features.
     * @param \Routeguide\Rectangle $request client request
     * @param \Grpc\ServerCallWriter $writer write response data of \Routeguide\Feature
     * @param \Grpc\ServerContext $context server request context
     * @return void
     */
    public function ListFeatures(
        \Routeguide\Rectangle $request,
        \Grpc\ServerCallWriter $writer,
        \Grpc\ServerContext $context
    ): void {
        $context->setStatus(\Grpc\Status::unimplemented());
        $writer->finish();
    }

    /**
     * A client-to-server streaming RPC.
     *
     * Accepts a stream of Points on a route being traversed, returning a
     * RouteSummary when traversal is completed.
     * @param \Grpc\ServerCallReader $reader read client request data of \Routeguide\Point
     * @param \Grpc\ServerContext $context server request context
     * @return \Routeguide\RouteSummary for response data, null if if error occured
     *     initial metadata (if any) and status (if not ok) should be set to $context
     */
    public function RecordRoute(
        \Grpc\ServerCallReader $reader,
        \Grpc\ServerContext $context
    ): ?\Routeguide\RouteSummary {
        $context->setStatus(\Grpc\Status::unimplemented());
        return null;
    }

    /**
     * A Bidirectional streaming RPC.
     *
     * Accepts a stream of RouteNotes sent while a route is being traversed,
     * while receiving other RouteNotes (e.g. from other users).
     * @param \Grpc\ServerCallReader $reader read client request data of \Routeguide\RouteNote
     * @param \Grpc\ServerCallWriter $writer write response data of \Routeguide\RouteNote
     * @param \Grpc\ServerContext $context server request context
     * @return void
     */
    public function RouteChat(
        \Grpc\ServerCallReader $reader,
        \Grpc\ServerCallWriter $writer,
        \Grpc\ServerContext $context
    ): void {
        $context->setStatus(\Grpc\Status::unimplemented());
        $writer->finish();
    }

    /**
     * Get the method descriptors of the service for server registration
     *
     * @return array of \Grpc\MethodDescriptor for the service methods
     */
    public final function getMethodDescriptors(): array
    {
        return [
            '/routeguide.RouteGuide/GetFeature' => new \Grpc\MethodDescriptor(
                $this,
                'GetFeature',
                '\Routeguide\Point',
                \Grpc\MethodDescriptor::UNARY_CALL
            ),
            '/routeguide.RouteGuide/ListFeatures' => new \Grpc\MethodDescriptor(
                $this,
                'ListFeatures',
                '\Routeguide\Rectangle',
                \Grpc\MethodDescriptor::SERVER_STREAMING_CALL
            ),
            '/routeguide.RouteGuide/RecordRoute' => new \Grpc\MethodDescriptor(
                $this,
                'RecordRoute',
                '\Routeguide\Point',
                \Grpc\MethodDescriptor::CLIENT_STREAMING_CALL
            ),
            '/routeguide.RouteGuide/RouteChat' => new \Grpc\MethodDescriptor(
                $this,
                'RouteChat',
                '\Routeguide\RouteNote',
                \Grpc\MethodDescriptor::BIDI_STREAMING_CALL
            ),
        ];
    }

}