spring-graphql WebSocketGraphQlClientInterceptor 源码

  • 2022-08-16
  • 浏览 (706)

spring-graphql WebSocketGraphQlClientInterceptor 代码

文件路径:/spring-graphql/src/main/java/org/springframework/graphql/client/WebSocketGraphQlClientInterceptor.java

/*
 * Copyright 2020-2022 the original author or 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
 *
 *      https://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 org.springframework.graphql.client;


import java.util.Map;

import reactor.core.publisher.Mono;


/**
 * An extension of {@link GraphQlClientInterceptor} with additional methods to
 * for WebSocket interception points. Only a single interceptor of type
 * {@link WebSocketGraphQlClientInterceptor} may be configured.
 *
 * @author Rossen Stoyanchev
 * @since 1.0.0
 */
public interface WebSocketGraphQlClientInterceptor extends GraphQlClientInterceptor {

	/**
	 * Provide a {@code Mono} that returns the payload for the
	 * {@code "connection_init"} message. The {@code Mono} is subscribed to every
	 * type a new WebSocket connection is established.
	 */
	default Mono<Object> connectionInitPayload() {
		return Mono.empty();
	}

	/**
	 * Handler the {@code "connection_ack"} message received from the server at
	 * the start of the WebSocket connection.
	 * @param ackPayload the payload of the {@code "connection_ack"} message
	 */
	default Mono<Void> handleConnectionAck(Map<String, Object> ackPayload) {
		return Mono.empty();
	}

}

相关信息

spring-graphql 源码目录

相关文章

spring-graphql AbstractDelegatingGraphQlClient 源码

spring-graphql AbstractGraphQlClientBuilder 源码

spring-graphql ClientGraphQlRequest 源码

spring-graphql ClientGraphQlResponse 源码

spring-graphql ClientResponseField 源码

spring-graphql CodecDelegate 源码

spring-graphql DefaultClientGraphQlRequest 源码

spring-graphql DefaultClientGraphQlResponse 源码

spring-graphql DefaultClientResponseField 源码

spring-graphql DefaultGraphQlClient 源码

0  赞