socket-wsa.h (1643B)
1/* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 20#ifndef GUAC_SOCKET_WSA_H 21#define GUAC_SOCKET_WSA_H 22 23/** 24 * Provides an implementation of guac_socket specific to the Windows Socket API 25 * (aka WSA or "winsock"). This header will only be available if libguac was 26 * built with WSA support. 27 * 28 * @file socket-wsa.h 29 */ 30 31#include "socket-types.h" 32 33#include <winsock2.h> 34 35/** 36 * Creates a new guac_socket which will use the Windows Socket API (aka WSA or 37 * "winsock") for all communication. Freeing this guac_socket will 38 * automatically close the associated SOCKET handle. 39 * 40 * @param sock 41 * The WSA SOCKET handle to use for the connection underlying the created 42 * guac_socket. 43 * 44 * @return 45 * A newly-allocated guac_socket which will transparently use the Windows 46 * Socket API for all communication. 47 */ 48guac_socket* guac_socket_open_wsa(SOCKET sock); 49 50#endif 51